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/.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 c8023ac7cc..72c839af99 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -24,7 +24,7 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -46,28 +46,9 @@ "template_folder": "_themes", "version": 0, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/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 - }, { "docset_name": "skype-ps", "build_source_folder": "skype", @@ -92,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": [], @@ -112,7 +93,10 @@ }, "build_entry_point": "docs", "template_folder": "_themes", - "version": 0 + "version": 0, + "monikerPath": [ + "mapping/MAML2Yaml/monikerMapping.json" + ] }, { "docset_name": "teams-ps", @@ -138,28 +122,9 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/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 - }, { "docset_name": "whiteboard-ps", "build_source_folder": "whiteboard", @@ -184,7 +149,7 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] } ], @@ -192,10 +157,7 @@ "sync_notification_subscribers": [], "branches_to_filter": [], "git_repository_branch_open_to_public_contributors": "main", - "skip_source_output_uploading": false, "need_preview_pull_request": true, - "enable_incremental_build": false, - "contribution_branch_mappings": {}, "dependent_repositories": [ { "path_to_root": "_themes", @@ -209,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": [ { @@ -224,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 36c1a75206..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,6512 +162,6512 @@ }, { "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-maildetailatpreport", + "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-safelinksaggregatereport", + "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-maildetailatpreport", + "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-maildetailatpreport", + "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-myanalyticsfeatureconfig", + "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-myanalyticsfeatureconfig", + "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/myanalyticsfeatureconfig", + "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/myanalyticsfeatureconfig", + "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": "https://docs.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-TenantAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-UserAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-UserAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig", + "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-MailDetailMalwareReport.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/Get-MailDetailSpamReport.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/Get-AdvancedThreatProtectionTrafficReport.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/Get-UrlTrace.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-safelinksaggregatereport", + "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", "redirect_document_id": false }, { @@ -6762,23 +6762,2265 @@ }, { "source_path": "exchange/virtual-folder/exchange/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/#encryption-and-certificates", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/#encryption-and-certificates", + "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 5f441c1582..799d11a6c6 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,92 @@ -# Overview - -**Short URL**: - -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. - -![Contribution and Consumption model for Office PowerShell reference content.](images/contrib-consumption-model.png) - -## Learn How To Contribute +--- +ms.date: 05/16/2025 +--- -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 +# Overview -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. +## Learn how to contribute -This brief video also covers how to contribute: +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: . -[![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/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 68d337f84c..f23758f7ff 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -1,154 +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 +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 the following versions of 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 2.0.6 Preview5 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). > -> For instructions on how to install or update the module, see [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). +> - 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) -> - [Set-UnifiedGroup](/powershell/module/exchange/set-unifiedgroup) > - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) > - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) > -> You can use Microsoft Graph instead. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview) +> 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 cmdlets: -> - [Get-ComplianceCase](/powershell/module/exchange/get-compliancecase) -> - [Get-CaseHoldPolicy](/powershell/module/exchange/get-caseholdpolicy) - -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 is not 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 Azure AD apps and self-signed certificates. +> - 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.` -The following examples show how to use the Exchange Online PowerShell V2 module with app-only authentication: +## How does it work? -> [!IMPORTANT] -> In the **Connect-** commands, be sure to use an `.onmicrosoft.com` domain for the _Organization_ parameter value. Otherwise, you might encounter cryptic permission issues when you run commands in the app context. +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. -- Connect using a local certificate: +## Connection examples - - **Exchange Online PowerShell**: +The following examples show how to use the Exchange Online PowerShell module with app-only authentication: - ```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" - ``` +> [!IMPORTANT] +> 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. - - **Security & Compliance PowerShell**: +- **Connect using a certificate thumbprint**: - ```powershell - Connect-IPPSSession -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. - - **Exchange Online PowerShell**: + - Exchange Online PowerShell: ```powershell Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" ``` - - **Security & Compliance PowerShell**: + - Security & Compliance PowerShell: ```powershell Connect-IPPSSession -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" ``` - 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. +- **Connect using a certificate object**: -- Connect using a certificate object: + 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. - - **Exchange Online PowerShell**: + - Exchange Online PowerShell: ```powershell Connect-ExchangeOnline -Certificate <%X509Certificate2 Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" ``` - - **Security & Compliance PowerShell**: + - Security & Compliance PowerShell: ```powershell Connect-IPPSSession -Certificate <%X509Certificate2 Object%> -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 local certificate**: -> [!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). + > [!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. -## 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. The session's role based access control (RBAC) is configured using the directory role information that's available in the token. + ```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" + ``` + + - Security & Compliance PowerShell: + + ```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" + ``` ## Set up app-only authentication -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). +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). -For a detailed visual flow about creating applications in Azure AD, see . +For a detailed visual flow about creating applications in Microsoft Entra ID, see . -1. [Register the application in Azure AD](#step-1-register-the-application-in-azure-ad). +1. [Register the application in Microsoft Entra ID](#step-1-register-the-application-in-microsoft-entra-id). 2. [Assign API permissions to the application](#step-2-assign-api-permissions-to-the-application). - An application object has the default permission `User.Read`. For the application object to access resources, it needs to have the Application permission `Exchange.ManageAsApp`. + 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**. 3. [Generate a self-signed certificate](#step-3-generate-a-self-signed-certificate) - - 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. + - 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. - - 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. + - 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. - - 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. + - 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] - > 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. + > 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. -4. [Attach the certificate to the Azure AD application](#step-4-attach-the-certificate-to-the-azure-ad-application) +4. [Attach the certificate to the Microsoft Entra application](#step-4-attach-the-certificate-to-the-microsoft-entra-application) -5. [Assign Azure AD roles to the application](#step-5-assign-azure-ad-roles-to-the-application) +5. [Assign Microsoft Entra roles to the application](#step-5-assign-microsoft-entra-roles-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 supported built-in roles. + 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. -## Appendix - -## Step 1: Register the application in Azure AD +### Step 1: Register the application in Microsoft Entra ID > [!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. - -1. Open the Azure AD portal at . +> 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. -2. Under **Manage Azure Active Directory**, click **View**. +1. Open the Microsoft Entra admin center at . - ![Click View in the Azure AD portal under Manage Azure Active Directory.](media/exo-app-only-auth-manage-ad-view.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. -3. On the **Overview** page that opens, under **Manage**, select **App registrations**. + ![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) - ![Select App registrations.](media/exo-app-only-auth-select-app-registrations.png) + Or, to go directly to the **App registrations** page, use . -4. On the **App registrations** page that opens, click **New registration**. +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) @@ -158,69 +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)**. - 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. + - **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] + > 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: + +- 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 and assign the API permissions from the portal + +1. On the app **Overview** page, select **API permissions** from the **Manage** section. + + ![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. -1. On the app page under **Management**, select **Manifest**. + ![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) - ![Select Manifest on the application properties page.](media/exo-app-only-auth-select-manifest.png) +4. On the **What type of permissions does your application require?** flyout that appears, select **Application permissions**. -2. On the **Manifest** page that opens, find the `requiredResourceAccess` entry (on or about line 47). +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**. - Modify the `resourceAppId`, `resourceAccess`, `id`, and `type` values as shown in the following code snippet: +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" + > } + > ] + > } + > ], + > ``` -3. Still on the **Manifest** page, under **Management**, select **API permissions**. + When you're finished on the **Manifest** page, select **Save**. - ![Select API permissions on the application properties page.](media/exo-app-only-auth-select-api-permissions.png) +3. Still on the **Manifest** page, select **API permissions** from the **Manage** section. - On the **API permissions** page that opens, do the following steps: + ![Select API permissions from the Manifest page.](media/exo-app-only-auth-manifest-select-api-permissions.png) - - **API / Permissions name**: Verify the value **Exchange.ManageAsApp** is shown. +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**. - > [!NOTE] - > If necessary, search for **Office 365 Exchange** under **APIs my organization uses** on the **Request API Permissions** page. + - **Status**: The current incorrect value is **Not granted for \** for the **Office 365 Exchange Online** \> **Exchange.ManageAsApp** entry. + + Change the **Status** value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. - - **Status**: The current incorrect value is **Not granted for \**, and this value needs to be changed. + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) - ![Original incorrect API permissions.](media/exo-app-only-auth-original-permissions.png) + The **Status** value is now **Granted for \**. - Select **Grant admin consent for \**, read the confirmation dialog that opens, and then click **Yes**. + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) - The **Status** value should now be **Granted for \**. +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. - ![Admin consent granted.](media/exo-app-only-auth-admin-consent-granted.png) + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) -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. +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 +### Step 3: Generate a self-signed certificate Create a self-signed x.509 certificate using one of the following methods: @@ -231,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 @@ -243,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. +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. - If you need to get back to **Apps registration** page, do the following steps: - - 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. @@ -277,51 +381,76 @@ 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 + +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: + +`https://login.microsoftonline.com//adminconsent?client_id=&scope=https://outlook.office365.com/.default` + +- `` is the customer's tenant ID. +- `` is the ID of the multi-tenant application. +- The default scope is used to grant application permissions. + +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). + +### Step 5: Assign Microsoft Entra roles to the application + +You have two options: + +- **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. + +> [!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. -Azure AD has more than 50 admin roles available. The supported roles are described in the following table: +#### Assign Microsoft Entra roles to the application -|Role|Exchange Online PowerShell|Security & Compliance PowerShell| +The supported Microsoft Entra roles are described in the following table: + +|Role|Exchange Online
PowerShell|Security & Compliance
PowerShell| |---|:---:|:---:| -|Compliance Administrator|![Check mark.](media/checkmark.png)|![Check mark.](media/checkmark.png)| -|Exchange Administrator\*|![Check mark.](media/checkmark.png)|| -|Global Administrator\*|![Check mark.](media/checkmark.png)|![Check mark.](media/checkmark.png)| -|Global Reader|![Check mark.](media/checkmark.png)|![Check mark.](media/checkmark.png)| -|Helpdesk Administrator|![Check mark.](media/checkmark.png)|| -|Security Administrator\*|![Check mark.](media/checkmark.png)|![Check mark.](media/checkmark.png)| -|Security Reader|![Check mark.](media/checkmark.png)|![Check mark.](media/checkmark.png)| +|[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: +¹ 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. -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). +² 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. On the Azure AD portal at , under **Manage Azure Active Directory**, click **View**. +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. - ![View in the Azure AD portal under Manage Azure Active Directory.](media/exo-app-only-auth-manage-ad-view.png) + ![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) -2. On the **Overview** page that opens, under **Manage**, select **Roles and administrators**. + Or, to go directly to the **Microsoft Entra roles and administrators** page, use . - ![Select Roles and administrators from the overview page.](media/exo-app-only-auth-select-roles-and-administrators.png) +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. -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. - - - **Exchange Online PowerShell**: + - **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**: + - **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) -4. On the **Assignments** page that opens, click **Add assignments**. +3. On the **Assignments** page that opens, select **Add assignments**. - **Exchange Online PowerShell**: @@ -331,13 +460,13 @@ For general instructions about assigning roles in Azure AD, see [View and assign ![Select Add assignments on the role assignments page for Security & Compliance PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png) -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). +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**. -6. Back on the **Assignments** page, verify that the app has been assigned to the role. +5. Back on the **Assignments** page, verify that the role has been assigned to the app. - **Exchange Online PowerShell**: @@ -346,3 +475,66 @@ For general instructions about assigning roles in Azure AD, see [View and assign - **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 + ``` + + 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 d143e97b8e..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 -ms.localizationpriority: medium -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 be deprecated starting on October 1, 2022](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-may-2022/ba-p/3301866) 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**: The following commands require that WinRM is enabled. To enable WinRM, run the following 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 8ed4648aa8..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 -ms.localizationpriority: high -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 be deprecated starting on October 1, 2022](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-may-2022/ba-p/3301866) 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 The following commands require that WinRM is enabled. To enable WinRM, run the following 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 05efac5cbe..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: "Basic auth - Connect to Security & Compliance PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.localizationpriority: medium -ms.assetid: -ROBOTS: NOINDEX -search.appverid: MET150 -description: "Learn how to connect to Security & Compliance PowerShell." ---- - -# Basic auth - Connect to Security & Compliance PowerShell - -> [!NOTE] -> The connection instructions in this article [will be deprecated starting on October 1, 2022](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-deprecation-in-exchange-online-may-2022/ba-p/3301866) 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 PowerShell. For instructions, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). - -Security & Compliance PowerShell allows you to manage your Microsoft 365 Defender portal and Microsoft Purview compliance portal settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Security & Compliance 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 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 PowerShell. For instructions, see [Connect to Security & Compliance PowerShell using the EXO V2 module](connect-to-scc-powershell.md). -> -> Some features in the Microsoft 365 Defender portal and Microsoft Purview compliance portal (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 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 Purview compliance portal](/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** The following commands require that WinRM is enabled. To enable WinRM, run the following 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 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 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 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 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 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 Security & Compliance 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 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 ffa7866298..bbd2cf89d9 100644 --- a/exchange/docs-conceptual/cmdlet-property-sets.md +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -1,27 +1,30 @@ --- -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 +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 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 1e755b275a..75be6dcc6a 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -1,180 +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 +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). > - > If you're using version 2.0.6 of the module, if you don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command, you'll have access only to the available REST API cmdlets. For more information, see [Updates for version 2.0.6](exchange-online-powershell-v2.md#updates-for-version-206). + > 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). - \* 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). - - 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-ExchangeOnline** command. If it doesn't work, then you need to use the _UserPrincipalName_ parameter. - - 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. + \* 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 563730191e..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,144 +1,109 @@ --- 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 +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. +## Connect to Exchange Online Protection PowerShell using modern authentication with or without MFA -2. The command that you need to run uses the following syntax: +These connection instructions use modern authentication and work with or without multi-factor authentication (MFA). - ```powershell - Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndPointUri ] [-PSSessionOption $ProxyOptions] - ``` - - - _\_ 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/ - ``` - -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] +> 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] - > 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. +The command that you need to run uses the following syntax: -2. Run the following command: +```powershell +Connect-ExchangeOnline -UserPrincipalName [-ShowBanner:$false] +``` - > [!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. +For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - ```powershell - $UserCredential = Get-Credential - ``` +- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). - In the **Windows PowerShell Credential Request** dialog box that appears, type your work or school account and password, and then click **OK**. +- 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). -3. The last command that you need to run uses the following syntax: +### Connect to Exchange Online Protection PowerShell with an interactive login prompt - ```powershell - Connect-IPPSSession [-Credential $UserCredential] -ConnectionUri [-PSSessionOption $ProxyOptions] - ``` +This example works in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: - - 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. +```powershell +Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com +``` - **This example connects to Exchange Online Protection PowerShell in a Microsoft 365 organization**: +## Step 3: Disconnect when you're finished - ```powershell - Connect-IPPSSession -Credential $UserCredential -ConnectionUri https://ps.protection.outlook.com/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. 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 dce81c7883..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,8 +2,8 @@ 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 @@ -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? @@ -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 fbe776bccd..b35779fdaf 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -1,115 +1,187 @@ --- -title: Connect to Security & Compliance 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 +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 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 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 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 PowerShell](basic-auth-connect-to-scc-powershell.md). - -To use the older Exchange Online Remote PowerShell Module to connect to Security & Compliance PowerShell using MFA, see [V1 module - Connect to Security & Compliance 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). > [!NOTE] - > Security & Compliance PowerShell still requires Basic authentication in WinRM as described [Prerequisites for the EXO V2 module](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm). REST API cmdlets that allow you to turn off Basic authentication in WinRM are not yet available for the **Connect-IPPSSession** cmdlet. For more information, see [Updates for version 2.0.6](exchange-online-powershell-v2.md#updates-for-version-206). + > 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). -- 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 Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +- 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). -## Connect to Exchange Online PowerShell using modern authentication with or without MFA +## Step 1: Load the Exchange Online PowerShell module -These connection instructions use modern authentication and work with or without multi-factor authentication (MFA). +> [!NOTE] +> If the module is already installed, you can typically skip this step and run **Connect-IPPSSession** without manually loading the module first. -1. In a Windows PowerShell window, load the EXO V2 module by running the following command: +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 - ``` +```powershell +Import-Module ExchangeOnlineManagement +``` - **Notes**: +## Step 2: Connect and authenticate - - 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-IPPSSession** without loading the module first. +> [!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. -2. The command that you need to run uses the following syntax: +The command that you need to run uses the following syntax: - ```powershell - Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-PSSessionOption $ProxyOptions] - ``` +```powershell +Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +``` - - _\_ 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 following examples or the parameter description in [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - - The _AzureADAuthorizationEndpointUri_ parameter is required in some environments and not in others. For more information, see the following examples or the parameter description 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). - - 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. - - 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. +For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - **This example connects to Security & Compliance PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: +- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). - ```powershell - Connect-IPPSSession -UserPrincipalName navin@contoso.com - ``` +- 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 PowerShell in an Office 365 operated by 21Vianet 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 li@fabrikam.cn -ConnectionUri https://ps.compliance.protection.partner.outlook.cn/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 PowerShell in a Microsoft GCC High 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 chris@govt.us -ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common - ``` +### Connect to Security & Compliance PowerShell with an interactive login prompt - **This example connects to Security & Compliance PowerShell in a Microsoft 365 DoD organization**: +1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: - ```powershell - Connect-IPPSSession -UserPrincipalName michelle@govt.mil -ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common - ``` + - **This example connects to Security & Compliance PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). + ```powershell + Connect-IPPSSession -UserPrincipalName navin@contoso.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. + - **This example connects to Security & Compliance PowerShell in a Microsoft GCC High organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName chris@govt.us -ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common + ``` + + - **This example connects to Security & Compliance PowerShell in a Microsoft 365 DoD organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName michelle@govt.mil -ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common + ``` + + - **This example connects to Security & Compliance PowerShell in an Office 365 operated by 21Vianet organization**: + + ```powershell + Connect-IPPSSession -UserPrincipalName li@fabrikam.cn -ConnectionUri https://ps.compliance.protection.partner.outlook.cn/powershell-liveid -AzureADAuthorizationEndpointUri https://login.chinacloudapi.cn/common + ``` + +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) + + > [!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) + +### Connect to Security & Compliance 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 Security & Compliance PowerShell in customer organizations + +The procedures in this section require version 3.0.0 or later of the module. + +In Security & Compliance PowerShell, you need to use the _AzureADAuthorizationEndpointUri_ with the _DelegatedOrganization_ parameter. + +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-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com -AzureADAuthorizationEndpointUri https://login.microsoftonline.com/adatum.onmicrosoft.com + ``` + +## 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: -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 connected successfully. A quick test is to run a Security & Compliance PowerShell cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. +```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 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 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 22097f499d..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,8 +2,8 @@ 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 @@ -15,7 +15,7 @@ description: "Administrators can learn how to block or allow users' remote Power # 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 527999387f..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,8 +2,8 @@ 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 @@ -11,48 +11,58 @@ ms.service: exchange-powershell 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 $_.WindowsEmailAddress -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 $_.WindowsEmailAddress -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 1f846e6a4f..2d91c08839 100644 --- a/exchange/docs-conceptual/exchange-cmdlet-syntax.md +++ b/exchange/docs-conceptual/exchange-cmdlet-syntax.md @@ -2,8 +2,8 @@ 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 @@ -31,22 +31,22 @@ Exchange PowerShell help follows conventions that indicate what's required or op |---|---| |`-`|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_ @@ -56,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 @@ -80,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 actual values. +- **Single quotation marks**: Variables are treated literally. -- **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`. +For example, `$Server = Mailbox01` results in the following output based on which quotation marks you use: -- **Single quotation marks**: Variables are treated literally. The input **'$Server Example'** results in the output `$Server Example`. +- **"$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). @@ -96,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 ( `''` ). @@ -108,17 +120,17 @@ The following table shows the valid operators that you can use in an Exchange co |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`.| diff --git a/exchange/docs-conceptual/exchange-management-shell.md b/exchange/docs-conceptual/exchange-management-shell.md index 60789d8dc4..f10d3cc542 100644 --- a/exchange/docs-conceptual/exchange-management-shell.md +++ b/exchange/docs-conceptual/exchange-management-shell.md @@ -2,8 +2,8 @@ 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 @@ -15,33 +15,33 @@ description: "Learn about Exchange Server PowerShell, also known as the Exchange # 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: > -> - 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](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](connect-to-exchange-servers-using-remote-powershell.md). +> - 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). - -2. Perform authentication checks. +When you select the Exchange Management Shell shortcut on an Exchange server, the local instance of Windows PowerShell takes the following steps: -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. @@ -54,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. @@ -80,4 +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 015422da2a..5849e19153 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -1,56 +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 +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 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 + ``` -## How the EXO V2 module works + Instead, use the **Update-DistributionGroupMember** command to update fewer members, and then add the remaining members individually using an **Add-DistributionGroupMember** command. For example: -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. + ```powershell + Update-DistributionGroupMember -Identity DG01 -Members $Members[0..4999] + + $Remaining = $Members[-5000..-1] + + foreach ($Member in $Remaining) + + { + Add-DistributionGroupMember -Identity DG01 -Member $Member + } + ``` + +For more information about what's new in the EXO V3 module, see the [Release notes](#release-notes) section later in this article. + +## 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: -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](#turn-on-basic-authentication-in-winrm). +```powershell +Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath -LogLevel All +``` -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). +## Cmdlets in the Exchange Online PowerShell module -The improved Exchange Online PowerShell cmdlets that are only available in the EXO V2 module are listed in the following table: +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 V2 module cmdlet|Older related cmdlet| +|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)| @@ -62,107 +158,70 @@ The improved Exchange Online PowerShell cmdlets that are only available in the E |[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}`. + +The connection-related cmdlets in the module are listed in the following table: -|EXO V2 module cmdlet|Older related cmdlet|Comments| +|EXO module cmdlet|Older related cmdlet|Comments| |---|---|---| -|[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)|| +|[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)|n\a|Available in v2.0.6-Preview7 or later.| +|[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 EXO V2 module are listed in the following table: +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-CustomNudge](/powershell/module/exchange/get-customnudge)|Available in v2.0.6-Preview5 or later| -|[New-CustomNudge](/powershell/module/exchange/new-customnudge)|Available in v2.0.6-Preview5 or later| -|[Remove-CustomNudge](/powershell/module/exchange/remove-customnudge)|Available in v2.0.6-Preview5 or later| -|[Set-CustomNudge](/powershell/module/exchange/set-customnudge)|Available in v2.0.6-Preview5 or later| -|[Get-CustomNudgeAssignment](/powershell/module/exchange/get-customnudgeassignment)|Available in v2.0.6-Preview5 or later| -|[New-CustomNudgeAssignment](/powershell/module/exchange/new-customnudgeassignment)|Available in v2.0.6-Preview5 or later| -|[Remove-CustomNudgeAssignment](/powershell/module/exchange/remove-customnudgeassignment)|Available in v2.0.6-Preview5 or later| -|[Set-CustomNudgeAssignment](/powershell/module/exchange/set-customnudgeassignment)|Available in v2.0.6-Preview5 or later| -|[Get-CustomNudgeSettings](/powershell/module/exchange/get-customnudgesettings)|Available in v2.0.6-Preview5 or later| -|[Set-CustomNudgeSettings](/powershell/module/exchange/set-customnudgesettings)|Available in v2.0.6-Preview5 or later| +|[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 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.| -### Updates for version 2.0.6 - -Preview versions of v2.0.6 are now available. v2.0.6 of the EXO V2 module improves upon the historical capabilities of the module with the following features: - -- Exchange Online PowerShell in version 2.0.6 includes cmdlets that are backed by the REST API: - - REST API cmdlets don't rely on the remote PowerShell session, so PowerShell on your client computer doesn't need [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) for Exchange Online PowerShell. - - REST API cmdlets in Exchange Online PowerShell work just like their remote PowerShell equivalents, so you don't need to update any of your scripts. - - Virtually all of the available remote PowerShell cmdlets in Exchange Online are now backed by the REST API. Some cmdlets might temporarily appear or disappear from availability using the REST API as we find and fix issues. - -- The _UseRPSSession_ switch in **Connect-ExchangeOnline** grants access to all existing remote PowerShell cmdlets as before: - - The _UseRPSSession_ switch requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) on your client computer. - - If you don't use the _UseRPSSession_ switch when you connect, you can use _only_ the REST API cmdlets. - -- A few REST API cmdlets in Exchange Online PowerShell have been updated with the experimental _UseCustomRouting_ switch. This switch routes the command directly to the required Mailbox server, and might improve overall performance. - - 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 REST API cmdlets in Exchange Online PowerShell: - - **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 _UseCustomRouting_ switch experimentally and [report any issues](#report-bugs-and-issues-for-the-exo-v2-module) that you encounter. - -- In v2.0.6-Preview7, you can use the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet to get information about all REST-based connections in the current PowerShell session with Exchange Online. +## Install and maintain the Exchange Online PowerShell module -> [!NOTE] -> Security & Compliance PowerShell in version 2.0.6 does not include cmdlets that are backed by the REST API. **All** cmdlets in Security & Compliance PowerShell rely on the remote PowerShell session, so PowerShell on your client computer requires [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) to successfully use the **Connect-IPPSSession** cmdlet. - -## Install and maintain the EXO V2 module +You download the module from the PowerShell gallery at . -You can download the EXO V2 module from the PowerShell gallery at . +The procedures in this section explain how to install, update, and uninstall the module. -The procedures in this section explain how to install, update, and uninstall the EXO V2 module. +### Supported operating systems for the Exchange Online PowerShell module -### Supported operating systems for the EXO V2 module +The latest versions of the module are officially supported in PowerShell 7 on Windows, Linux, and Apple macOS. -The latest version of the EXO V2 module is 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). -> [!NOTE] -> As described in the installation article, you need to install OpenSSL, which is required for WSMan. +As described in the installation article, you need to install OpenSSL, which is required for WSMan. After you install PowerShell 7 and OpenSSL, do the following steps: @@ -177,16 +236,15 @@ After you install PowerShell 7 and OpenSSL, do the following steps: If prompted, accept PSGallery as the source for the cmdlets. -Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exo-v2-module) and [install the EXO V2 module](#install-the-exo-v2-module). +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 EXO V2 module is officially supported in the following distributions of Linux: +The module is officially supported in the following distributions of Linux: -- Ubuntu 18.04 LTS +- Ubuntu 24.04 LTS - Ubuntu 20.04 LTS - -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. +- 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). @@ -203,39 +261,39 @@ After you install PowerShell 7, do the following steps: If prompted, accept PSGallery as the source for the cmdlets. -Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exo-v2-module) and [install the EXO V2 module](#install-the-exo-v2-module). +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, v2.0.5 or earlier versions of the module don't work in Linux. You need to use v2.0.6 or later in Linux to connect from a network that's behind a proxy server. +> 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. -Version 2.0.5 or later of the EXO V2 module requires the Microsoft .NET Framework 4.7.1 or later to connect. Otherwise, you'll get an `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.1, see [this article](/dotnet/framework/migration-guide/versions-and-dependencies#net-framework-471). +PowerShell 7 on Windows requires version 2.0.4 or later. -Windows PowerShell requirements and EXO V2 module support in older versions of Windows are described in the following list: +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). -- Windows 8.14 -- Windows Server 2012 or Windows Server 2012 R24 -- Windows 7 Service Pack 1 (SP1)1,2,3 -- Windows Server 2008 R2 SP11,2,3 +Windows PowerShell requirements and module support **in older versions of Windows** are described in the following list: -- 1 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. -- 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. -- 3 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). +- Windows 8.1¹ +- Windows Server 2012 or Windows Server 2012 R2¹ +- Windows 7 Service Pack 1 (SP1)² ³ ⁴ +- Windows Server 2008 R2 SP1² ³ ⁴ -### Prerequisites for the EXO V2 module +- ¹ 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). -> [!NOTE] -> The settings described in this section are required in all versions of PowerShell on all operating systems. +### Prerequisites for the Exchange Online PowerShell module #### Set the PowerShell execution policy to RemoteSigned -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: +> [!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 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. @@ -249,10 +307,10 @@ For more information about execution policies, see [About Execution Policies](/p #### Turn on Basic authentication in WinRM -> [!NOTE] -> As described [earlier in this article](#updates-for-version-206), v2.0.6 of the EXO V2 module does not require Basic authentication in WinRM for REST API cmdlets. +> [!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. -WinRM needs to allow Basic authentication. 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. +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. To verify that Basic authentication is enabled for WinRM, run the following command in a **Command Prompt** or **Windows PowerShell**: @@ -278,31 +336,39 @@ If you don't see the value `Basic = true`, you need to run **one** of the follow ``` - **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'll get one of the following errors when you try to connect: +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. - + +### PowerShellGet for REST API connections in Windows + +[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). - -### Install the EXO V2 module +> 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`. -To install the EXO V2 module for the first time, complete the following steps: +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: + +> 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): @@ -316,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): @@ -334,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. + +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 (in an elevated PowerShell window vs. `Scope CurrentUser`): + - 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): @@ -360,21 +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, you can upgrade to the latest available Preview version, or you can use the _RequiredVersion_ parameter to upgrade to a specific Preview version. To see the available Preview versions, run the command: `Find-Module ExchangeOnlineManagement -AllVersions -AllowPrerelease`. + - 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. - Run **one** of the following commands based on how you originally installed the module (in an elevated PowerShell window vs. `-Scope CurrentUser`): - - - 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 -AllowPrerelease [-RequiredVersion ] + 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 -AllowPrerelease -Scope CurrentUser [-RequiredVersion ] - ``` + - 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. @@ -386,18 +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 '\' is not supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'ExchangeOnlineManagement'. - + > 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'. + > WARNING: Unable to download from URI 'https://go.microsoft.com/fwlink/?LinkID=627338&clcid=0x409' to ''. > 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: @@ -406,10 +524,10 @@ 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: @@ -420,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' @@ -428,27 +546,20 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m For more information, see [SchUseStrongCrypto](/dotnet/framework/network-programming/tls#schusestrongcrypto). -- 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 is not set to PSGallery. To fix this error, run the following command: - - ```powershell - Register-PSRepository -Default - ``` +### Uninstall the Exchange Online PowerShell module -### Uninstall the EXO V2 module +To see the version of the module that's currently installed and where it's installed, run the following command: -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`): + ```powershell + Get-InstalledModule ExchangeOnlineManagement | Format-List Name,Version,InstalledLocation + ``` -- In an elevated PowerShell window (all users): + 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. - ```powershell - Uninstall-Module -Name ExchangeOnlineManagement - ``` +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): -- 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 @@ -456,11 +567,11 @@ 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. The biggest and most used **Get-EXO\*** cmdlets use property sets: @@ -471,55 +582,134 @@ The biggest and most used **Get-EXO\*** cmdlets use property sets: 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). +- _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. -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. -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 + +- **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. -### Current release: Version 2.0.5 +#### Version 3.5.1 -- New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlet to manage ownerless Microsoft 365 groups. +- 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. @@ -531,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). + 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 @@ -552,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 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 807e12e5f4..348084ae8d 100644 --- a/exchange/docs-conceptual/exchange-online-powershell.md +++ b/exchange/docs-conceptual/exchange-online-powershell.md @@ -2,8 +2,8 @@ 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 @@ -11,16 +11,29 @@ ms.service: exchange-powershell 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 adbc1596cf..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 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 b6ae777767..acd6c6bdeb 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -2,8 +2,8 @@ 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 @@ -34,269 +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 72df141540..aae21efdc2 100644 --- a/exchange/docs-conceptual/filters-v2.md +++ b/exchange/docs-conceptual/filters-v2.md @@ -1,27 +1,30 @@ --- -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 +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 **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 [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. + +> [!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). ## Use client-side filtering for the best performance @@ -29,11 +32,11 @@ Server-side filtering uses the available _Filter_ or _RecipientFilter_ parameter Client-side filtering uses the [Where-Object](/powershell/module/microsoft.powershell.core/where-object) cmdlet (also known as **where** or **?**). -Generally, you get much better performance in Exchange 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. +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 EXO V2 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: +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|Unsupported filterable property|LDAP Display Name| |---|---|---| @@ -43,7 +46,7 @@ The **Get-EXO\*** cmdlets in the EXO V2 module support the majority of [filterab ## Supported operators -The following operators are fully supported for all string formats in the **Get-EXO\*** cmdlets 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 e75010969c..e19393384e 100644 --- a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md +++ b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md @@ -2,8 +2,8 @@ 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 @@ -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 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 Purview compliance portal](/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 c28370bda3..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: @@ -34,3 +33,33 @@ landingContent: 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/checkmark.png b/exchange/docs-conceptual/media/checkmark.png deleted file mode 100644 index 94f527ec14..0000000000 Binary files a/exchange/docs-conceptual/media/checkmark.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-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 18f0352880..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-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 05d1df2303..c097a3fc37 100644 --- a/exchange/docs-conceptual/open-the-exchange-management-shell.md +++ b/exchange/docs-conceptual/open-the-exchange-management-shell.md @@ -2,8 +2,8 @@ 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 @@ -15,21 +15,18 @@ description: "Find and open the shortcut for Exchange PowerShell (also known as # 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 bc8b864d9e..dc3ea8bf77 100644 --- a/exchange/docs-conceptual/recipient-filters.md +++ b/exchange/docs-conceptual/recipient-filters.md @@ -2,8 +2,8 @@ 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 @@ -15,21 +15,21 @@ description: "Learn about creating different kinds of recipient filters in the E # 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'"`). + - **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: + - **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"}`). - - **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"}`). + - **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,19 +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 e7410c7a42..0c75acd5b6 100644 --- a/exchange/docs-conceptual/recipientfilter-properties.md +++ b/exchange/docs-conceptual/recipientfilter-properties.md @@ -2,8 +2,8 @@ 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 @@ -36,17 +36,20 @@ 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. + +- 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). - 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). +- 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. @@ -117,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).|| @@ -182,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).|You must use the DistinguishedName. This property only works with groups recognized by Exchange, therefore Azure AD security groups do not work.| +|_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).|| diff --git a/exchange/docs-conceptual/scc-powershell.md b/exchange/docs-conceptual/scc-powershell.md index bbcadb1685..e5ec203673 100644 --- a/exchange/docs-conceptual/scc-powershell.md +++ b/exchange/docs-conceptual/scc-powershell.md @@ -2,8 +2,8 @@ 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 @@ -11,17 +11,32 @@ ms.service: exchange-powershell ms.localizationpriority: medium ms.assetid: 2f33bb84-cede-46f6-9d39-d246e8ce3543 search.appverid: MET150 -description: "Learn about using Security & Compliance PowerShell." +description: "Learn about the articles that are available for using PowerShell for Microsoft Security & Compliance PowerShell." --- # Security & Compliance PowerShell -Security & Compliance PowerShell is the administrative interface that enables you to manage the features that are available in the Microsoft 365 Defender portal and the Microsoft Purview compliance portal from the command line. For example, you can use Security & Compliance PowerShell to perform Compliance Searches. The following articles provide information about using Security & Compliance 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 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). + + > [!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 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). -Many of the cmdlets that are available in Security & Compliance PowerShell correspond to features that are only available in the Microsoft Purview compliance portal, so the related cmdlets are exclusive to Security & Compliance PowerShell. But, some cmdlets that are available in Security & Compliance PowerShell have the same names and functionality as those in Exchange Online PowerShell (for example, [Get-User](/powershell/module/exchange/get-user)). +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). -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. +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 7d62120900..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,18 +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: App-only authentication for unattended scripts + - 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: @@ -47,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: 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 PowerShell href: scc-powershell.md items: + - 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 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 da59e2b122..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 -ms.localizationpriority: medium -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 ce9603fcb0..0000000000 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md +++ /dev/null @@ -1,170 +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 -ms.localizationpriority: medium -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 - -> [!IMPORTANT] -> Support for the older Exchange Online Remote PowerShell Module that's described in this article will end on August 31, 2022. The ability to connect to Exchange Online PowerShell using this version of the module will end on December 31, 2022. -> -> We recommend using the Exchange Online PowerShell V2 module (EXO V2 module), which only uses modern authentication, and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module) and [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). For more information about the different versions of Exchange Online PowerShell modules, see [Understanding the Different Versions of Exchange Online PowerShell Modules and Basic Auth](https://techcommunity.microsoft.com/t5/exchange-team-blog/understanding-the-different-versions-of-exchange-online/ba-p/3394487). - -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**: The following commands require that WinRM is enabled. To enable WinRM, run the following 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 7692acda76..0000000000 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: "V1 module - Connect to Security & Compliance PowerShell using MFA" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -ms.localizationpriority: medium -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 PowerShell for multi-factor authentication (MFA) or federated authentication." ---- - -# V1 module - Connect to Security & Compliance PowerShell using MFA - -> [!NOTE] -> > Support for the older Exchange Online Remote PowerShell Module that's described in this article will end on August 31, 2022. The ability to connect to Security & Compliance PowerShell using this version of the module will end on December 31, 2022. -> -> We recommend using the Exchange Online PowerShell V2 module (EXO V2 module), which only uses modern authentication, and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For more information about the different versions of Exchange Online PowerShell modules, see [Understanding the Different Versions of Exchange Online PowerShell Modules and Basic Auth](https://techcommunity.microsoft.com/t5/exchange-team-blog/understanding-the-different-versions-of-exchange-online/ba-p/3394487). - -If your account uses multi-factor authentication (MFA) or federated authentication, you can't use the instructions at [Basic auth - Connect to Security & Compliance PowerShell](basic-auth-connect-to-scc-powershell.md) to use remote PowerShell to connect to Security & Compliance PowerShell. Instead, you need to install the Exchange Online Remote PowerShell Module, and use the **Connect-IPPSSession** cmdlet to connect to Security & Compliance 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 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 Purview compliance portal](/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**: The following commands require that WinRM is enabled. To enable WinRM, run the following 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 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 PowerShell in Microsoft 365 using the account chris@contoso.com. - - ```powershell - Connect-IPPSSession -UserPrincipalName chris@contoso.com - ``` - - This example connects to Security & Compliance 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 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 PowerShell 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 PowerShell. - -- The account you use to connect to Security & Compliance 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 0ec4854eaf..ea729cff90 100644 --- a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md +++ b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md @@ -2,8 +2,8 @@ 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 @@ -14,7 +14,7 @@ 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 @@ -26,188 +26,188 @@ 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 a27ccd1fc5..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. diff --git a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md index 3c86ccbed4..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. diff --git a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md index a8cab8ab29..ddec608aad 100644 --- a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-compliancecasemember +online version: https://learn.microsoft.com/powershell/module/exchange/add-compliancecasemember applicable: Security & Compliance title: Add-ComplianceCaseMember schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Add-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md index 7cd3b52bf9..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 diff --git a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md index 7deb0d243b..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 diff --git a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md index 65f18e7f85..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 diff --git a/exchange/exchange-ps/exchange/Add-FederatedDomain.md b/exchange/exchange-ps/exchange/Add-FederatedDomain.md index 8025e913b1..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 @@ -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 @@ -292,10 +299,10 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 aea80d8a93..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 @@ -66,7 +66,7 @@ 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -240,11 +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) -**Note**: When a 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. See the [Mailboxes to which your account has full access aren't automapped to Outlook profile](https://docs.microsoft.com/outlook/troubleshoot/profiles-and-accounts/full-access-mailbox-not-automapped-outlook-profile) article for more information. +**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). -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 @@ -415,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 ``` diff --git a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md index c6c15cf74c..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 ("). @@ -263,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. diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md index ad21411131..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 diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md index 60ea19e740..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: diff --git a/exchange/exchange-ps/exchange/Add-RecipientPermission.md b/exchange/exchange-ps/exchange/Add-RecipientPermission.md index db89220fff..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,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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. diff --git a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md index 342cf15d45..5f64ff5636 100644 --- a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-rolegroupmember +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 @@ -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 @@ -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 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: diff --git a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md index 149d0acf8f..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 9aa54a87f8..ddb6eb30ff 100644 --- a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin +online version: https://learn.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin applicable: Security & Compliance title: Add-eDiscoveryCaseAdmin schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Add-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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, you must first add the user to the eDiscovery Manager role group by running the Add-RoleGroupMember cmdlet. After the user is a member of this role group, you can run the Add-eDiscoveryCaseAdmin cmdlet to add the user to the list of eDiscovery Administrators. +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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md b/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md index 5f26b6a1ce..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 diff --git a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md index 5dbeddc138..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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Clear-MobileDevice.md b/exchange/exchange-ps/exchange/Clear-MobileDevice.md index a6479be9b1..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,7 +36,7 @@ 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 @@ -123,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) diff --git a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md index b991ae7bd0..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 diff --git a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md index 785922282b..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 diff --git a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md index db0e1bcd98..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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index c2b01681be..96f0891ba3 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -1,7 +1,7 @@ --- 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 @@ -13,13 +13,13 @@ 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 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,8 +42,10 @@ Connect-ExchangeOnline [-CertificateThumbprint ] [-Credential ] [-Device] + [-DisableWAM] [-EnableErrorReporting] [-InlineCredential] + [-LoadCmdletHelp] [-LogDirectoryPath ] [-LogLevel ] [-ManagedIdentity] @@ -51,6 +54,9 @@ Connect-ExchangeOnline [-PageSize ] [-ShowBanner] [-ShowProgress ] + [-SigningCertificate ] + [-SkipLoadingCmdletHelp] + [-SkipLoadingFormatData] [-TrackPerformance ] [-UseMultithreading ] [-UserPrincipalName ] @@ -59,9 +65,9 @@ Connect-ExchangeOnline ``` ## 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 @@ -70,66 +76,50 @@ For details about the current and past public versions of the EXO V2 module, see Connect-ExchangeOnline -UserPrincipalName chris@contoso.com ``` -This example connects to Exchange Online PowerShell using modern authentication, with or without multi-factor authentication (MFA). We aren't using the UseRPSSession parameter, so the connection uses REST and doesn't require Basic authentication to be enabled in WinROM on the local computer. But, only the subset of frequently used REST API parameters are available. +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 2 ```powershell -Connect-ExchangeOnline -UserPrincipalName chris@contoso.com -UseRPSSession -``` - -This example connects to Exchange Online PowerShell using modern authentication, with or without MFA. We're using the UseRPSSession parameter, so the connection requires Basic authentication to be enabled in WinRM on the local computer. But, all Exchange Online PowerShell cmdlets are available using traditional remote PowerShell access. - -### 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 PowerShell in an unattended scripting scenario using the public key of a certificate. - -### Example 4 -```powershell Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" ``` 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 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 PowerShell 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 PowerShell 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 @@ -147,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` @@ -193,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 @@ -213,11 +203,11 @@ 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. -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. +This parameter works only if the customer organization has agreed to your delegated management via the CSP program. -**Note**: Use an .onmicrosoft.com domain for the parameter value. Not doing so might result in permission-related issues when you run commands in the app context. +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. ```yaml Type: String @@ -233,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 @@ -280,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,7 +333,7 @@ The Certificate parameter specifies the certificate that's used for 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 @@ -335,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 @@ -363,7 +377,9 @@ You can use the following methods as a value for this parameter: - 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 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). + +**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 @@ -385,7 +401,7 @@ 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 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 @@ -423,11 +439,33 @@ Accept wildcard characters: False ``` ### -Device -**Note**: This parameter is available 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. -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. +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. -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. +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 +``` + +### -DisableWAM +**Note**: This parameter is available in version 3.7.2-Preview1 or later of the module. + +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 @@ -459,7 +497,7 @@ Accept wildcard characters: False ``` ### -InlineCredential -**Note**: This parameter is available 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. @@ -480,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`. @@ -515,14 +575,21 @@ Accept wildcard characters: False ``` ### -ManagedIdentity -**Note**: This parameter is available in version 2.0.6-Preview7 or later. +The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. -The ManagedIdentity switch connects to Exchange Online using a system-assigned or user-assigned managed identity. You don't need to specify a value with this switch. +Managed identity connections are currently supported for the following types of Azure resources: -Managed identity is currently supported for Azure Virtual Machines and Virtual Machine Scale Sets. +- 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) @@ -537,9 +604,11 @@ Accept wildcard characters: False ``` ### -ManagedIdentityAccountId -**Note**: This parameter is available in version 2.0.6-Preview7 or later. +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. -The ManagedIdentityAccountId parameter specifies the application ID of the service principal that corresponds to the user-assigned managed identity that's used for authentication. +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 @@ -555,9 +624,11 @@ Accept wildcard characters: False ``` ### -Organization -The Organization parameter specifies the organization that's used in CBA. 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 CBA, see [App-only authentication for unattended scripts in the EXO V2 module](https://aka.ms/exov2-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 @@ -626,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 @@ -648,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 @@ -667,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). @@ -685,13 +824,13 @@ Accept wildcard characters: False ``` ### -UseRPSSession -This parameter is available in version 2.0.6-Preview3 or later of the Exchange Online V2 module. +**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 [Prerequisites in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2#turn-on-basic-authentication-in-winrm). +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, but only the subset of frequently used REST API cmdlets are available. +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 diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index be0c5245e5..a260cad194 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -1,7 +1,7 @@ --- 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 @@ -13,13 +13,13 @@ 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 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,6 +32,7 @@ Connect-IPPSSession [[-Prefix] ] [[-CommandName] ] [[-FormatTypeName] ] + [-AccessToken ] [-AppId ] [-BypassMailboxAnchoring] [-Certificate ] @@ -41,68 +42,52 @@ Connect-IPPSSession [-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 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 PowerShell in a Microsoft 365 organization. - -The first command gets the user credentials and stores them in the $UserCredential variable. - -The second command connects the current PowerShell session using the credentials in the $UserCredential, which isn't MFA enabled. - -After the Connect-IPPSSession command is complete, the password key in the $UserCredential variable is emptied, and you can run Security & Compliance PowerShell cmdlets. +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. ### Example 2 ```powershell -Connect-IPPSSession -Credential (Get-Credential) -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession ``` -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 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. ### Example 3 ```powershell -Connect-IPPSSession -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" -``` - -Using the EXO V2 module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using the public key of a certificate. - -### Example 4 -```powershell Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" ``` -Using the EXO V2 module version 2.0.6-Preview5 or later, this example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. -### Example 5 +### Example 4 ```powershell Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` -Using the EXO V2 module version 2.0.6-Preview5 or later, 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. +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 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/` -- Exchange Online Protection PowerShell in standalone EOP organizations without Exchange Online mailboxes: `https://ps.protection.outlook.com/powershell-liveid/` ```yaml Type: String @@ -118,7 +103,7 @@ 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 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` @@ -140,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 @@ -156,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 @@ -176,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 @@ -223,10 +219,30 @@ 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 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 @@ -262,7 +278,7 @@ The Certificate parameter specifies the certificate that's used for 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 @@ -278,11 +294,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 @@ -306,7 +322,9 @@ You can use the following methods as a value for this parameter: - 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 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). + +**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 @@ -328,7 +346,7 @@ 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 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 @@ -364,9 +382,9 @@ Accept wildcard characters: False ``` ### -Organization -The Organization parameter specifies the organization that's used in CBA. 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. 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 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 @@ -382,7 +400,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). @@ -399,6 +417,30 @@ 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). diff --git a/exchange/exchange-ps/exchange/Connect-Mailbox.md b/exchange/exchange-ps/exchange/Connect-Mailbox.md index 0ebc70cbe6..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) @@ -351,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 @@ -372,7 +372,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -488,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 @@ -558,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) diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 28226083fe..3dc21e421f 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/delete-quarantinemessage +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 @@ -16,7 +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 -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 Delete-QuarantineMessage -Identities [-Identity ] [-Confirm] + [-EntityType ] + [-HardDelete] [-RecipientAddress ] [-WhatIf] [] @@ -34,13 +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. @@ -139,14 +145,53 @@ 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 +``` + +### -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 +``` + ### -RecipientAddress -{{ Fill RecipientAddress Description }} +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -156,9 +201,7 @@ 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 PowerShell. +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md index 999c4d535c..fe87141f2e 100644 --- a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule +applicable: Exchange Online title: Disable-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Disable-ATPProtectionPolicyRule [-Identity] ## 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://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -77,7 +77,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 +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 diff --git a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md b/exchange/exchange-ps/exchange/Disable-AddressListPaging.md index 089df61d97..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) diff --git a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md b/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md index b5f2730415..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Disable-App.md b/exchange/exchange-ps/exchange/Disable-App.md index 4a8d844126..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) diff --git a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md index e47674a112..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) diff --git a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md b/exchange/exchange-ps/exchange/Disable-DistributionGroup.md index 258de7f084..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) 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 index 61491be735..b611fc63b1 100644 --- a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-eopprotectionpolicyrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection title: Disable-EOPProtectionPolicyRule schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Disable-EOPProtectionPolicyRule [-Identity] ## 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://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,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) diff --git a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md index 65e7fb38b2..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md index d48f725b8d..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -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) 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 f5ac20f3fd..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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md b/exchange/exchange-ps/exchange/Disable-JournalArchiving.md index 65dda9d5a2..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 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 diff --git a/exchange/exchange-ps/exchange/Disable-JournalRule.md b/exchange/exchange-ps/exchange/Disable-JournalRule.md index 71277efe1e..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) diff --git a/exchange/exchange-ps/exchange/Disable-MailContact.md b/exchange/exchange-ps/exchange/Disable-MailContact.md index c306b4133d..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) diff --git a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md b/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md index f1c9a33ec3..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) diff --git a/exchange/exchange-ps/exchange/Disable-MailUser.md b/exchange/exchange-ps/exchange/Disable-MailUser.md index 49e16b6716..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) diff --git a/exchange/exchange-ps/exchange/Disable-Mailbox.md b/exchange/exchange-ps/exchange/Disable-Mailbox.md index 1aa9dfb7c8..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 @@ -351,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 diff --git a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md b/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md index e8b26fdf98..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) diff --git a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md index 196b45c616..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) diff --git a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md index 6098fb8d1e..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 diff --git a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md index d0f87f9ba3..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 diff --git a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md index f5e8890594..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) diff --git a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md index b052cedecf..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) diff --git a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md index 4beab9048f..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,7 +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 @@ -115,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) diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md similarity index 52% rename from exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md rename to exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md index 71f39e7618..8e8073a184 100644 --- a/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md +++ b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md @@ -1,59 +1,54 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-phishsimoverriderule -applicable: Security & Compliance -title: Remove-PhishSimOverrideRule +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: --- -# Remove-PhishSimOverrideRule +# Disable-ReportSubmissionRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -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). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-PhishSimOverrideRule [-Identity] +Disable-ReportSubmissionRule [-Identity] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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-PhishSimOverrideRule -Identity PhishSimOverrideRulea0eae53e-d755-4a42-9320-b9c6b55c5011 +Disable-ReportSubmissionRule -Identity DefaultReportSubmissionRule. ``` -This example remove the phishing simulation override rule. +This example disables the report submission rule if it's already enabled. ## 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 +The Identity parameter specifies the report submission rule that you want to disable. The default rule is named DefaultReportSubmissionRule. ```yaml -Type: PolicyIdParameter +Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: True Position: 0 @@ -68,11 +63,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 +Applicable: Exchange Online Required: False Position: Named @@ -82,13 +79,13 @@ Accept wildcard characters: False ``` ### -WhatIf -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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md index 28d8a76a58..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -56,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 @@ -71,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 @@ -91,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 diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md index 5485ec25bd..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -56,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 @@ -71,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 @@ -91,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 diff --git a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md index e8dd8e2e4e..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) 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 966cc33a22..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 diff --git a/exchange/exchange-ps/exchange/Disable-TransportAgent.md b/exchange/exchange-ps/exchange/Disable-TransportAgent.md index ef6ce896e1..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) diff --git a/exchange/exchange-ps/exchange/Disable-TransportRule.md b/exchange/exchange-ps/exchange/Disable-TransportRule.md index 9a856b3b69..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) diff --git a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md index 828ebd02ea..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 diff --git a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md index 681e845d58..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) diff --git a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md b/exchange/exchange-ps/exchange/Disable-UMIPGateway.md index 19aa52b4df..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) diff --git a/exchange/exchange-ps/exchange/Disable-UMMailbox.md b/exchange/exchange-ps/exchange/Disable-UMMailbox.md index 4246f0d8fc..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 diff --git a/exchange/exchange-ps/exchange/Disable-UMServer.md b/exchange/exchange-ps/exchange/Disable-UMServer.md index b707184521..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 diff --git a/exchange/exchange-ps/exchange/Disable-UMService.md b/exchange/exchange-ps/exchange/Disable-UMService.md index 4d22323feb..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 diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index b769eb6a07..c2a6bb1153 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -1,7 +1,7 @@ --- 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 @@ -13,24 +13,44 @@ 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. + +This cmdlet disconnects any connections and clears the cache. After a successful disconnect, you can't successfully run any cmdlets for your organization. -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. +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. diff --git a/exchange/exchange-ps/exchange/Dismount-Database.md b/exchange/exchange-ps/exchange/Dismount-Database.md index fbb6b2abf2..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 diff --git a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md b/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md index 8cb080dda2..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 diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md index 62e4c89a0d..af887e025f 100644 --- a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule +applicable: Exchange Online title: Enable-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Enable-ATPProtectionPolicyRule [-Identity] ## 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://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -77,7 +77,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 +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 diff --git a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md b/exchange/exchange-ps/exchange/Enable-AddressListPaging.md index 3a14efc3a9..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 diff --git a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md b/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md index 78adc12cb2..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md b/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md index 234a45634d..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 diff --git a/exchange/exchange-ps/exchange/Enable-App.md b/exchange/exchange-ps/exchange/Enable-App.md index e4d9814b08..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 diff --git a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md index 6a2a8b6892..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 diff --git a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md index f8c6b4e244..c2a69f5215 100644 --- a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-compliancetagstorage +online version: https://learn.microsoft.com/powershell/module/exchange/enable-compliancetagstorage applicable: Security & Compliance title: Enable-ComplianceTagStorage schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Enable-ComplianceTagStorage ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md index 3aeccd4e5d..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 @@ -74,7 +76,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -156,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 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 index 3df5d0364d..a73b54c47d 100644 --- a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-eopprotectionpolicyrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection title: Enable-EOPProtectionPolicyRule schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Enable-EOPProtectionPolicyRule [-Identity] ## 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://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ In organizations without Defender for Office 365, this example turns off the Sta Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-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 Enabled. +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 diff --git a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md index 80390a0bba..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 diff --git a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md index f9bbf9f947..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md index 627d15ec57..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 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 1d1d8869dd..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 diff --git a/exchange/exchange-ps/exchange/Enable-JournalRule.md b/exchange/exchange-ps/exchange/Enable-JournalRule.md index 7b55fd5900..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 diff --git a/exchange/exchange-ps/exchange/Enable-MailContact.md b/exchange/exchange-ps/exchange/Enable-MailContact.md index 0d67e1bee3..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 diff --git a/exchange/exchange-ps/exchange/Enable-MailUser.md b/exchange/exchange-ps/exchange/Enable-MailUser.md index f675c79103..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 @@ -123,7 +123,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/exchange/Enable-Mailbox.md index 0ed8c667f0..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 ] @@ -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 @@ -581,7 +583,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -616,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 @@ -682,7 +684,7 @@ In Outlook in Exchange Online, the value of this parameter is ignored. The name 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 @@ -725,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 @@ -744,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 @@ -822,7 +824,7 @@ You can use this switch to run tasks programmatically where prompting for admini 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 @@ -858,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 @@ -984,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 @@ -1006,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 diff --git a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md b/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md index 7b7436b14f..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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md index c20559161a..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 diff --git a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md index 8faf80886a..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 diff --git a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md index ef65459441..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,13 +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 365 Defender portal. +- 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 diff --git a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md index a6c275b54c..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 diff --git a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md index de920d934f..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 diff --git a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md index ff6b9019e5..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 diff --git a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md index 4d89128b7c..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 ``` @@ -236,7 +237,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md similarity index 53% rename from exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md index 76b4d89be6..9bf1aa79ac 100644 --- a/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md +++ b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md @@ -1,59 +1,54 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-secopsoverriderule -applicable: Security & Compliance -title: Remove-SecOpsOverrideRule +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: --- -# Remove-SecOpsOverrideRule +# Enable-ReportSubmissionRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -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). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-SecOpsOverrideRule [-Identity] +Enable-ReportSubmissionRule [-Identity] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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-SecOpsOverrideRule -Identity SecOpsOverrideRule6fed4b63-3563-495d-a481-b24a311f8329 +Enable-ReportSubmissionRule -Identity DefaultReportSubmissionRule. ``` -This example removes the SecOps mailbox override rule. +This example enables the report submission rule if it's already disabled. ## 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 +The Identity parameter specifies the report submission rule that you want to enable. The default rule is named DefaultReportSubmissionRule. ```yaml -Type: PolicyIdParameter +Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: True Position: 0 @@ -72,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 +Applicable: Exchange Online Required: False Position: Named @@ -82,13 +77,13 @@ Accept wildcard characters: False ``` ### -WhatIf -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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md index 3618c7bd6c..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -56,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 @@ -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: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,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 diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md index b4e46e1690..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -56,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 @@ -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: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,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 diff --git a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md index 20304d86b9..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 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 0ed3cf2eb9..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 diff --git a/exchange/exchange-ps/exchange/Enable-TransportAgent.md b/exchange/exchange-ps/exchange/Enable-TransportAgent.md index 69eec401ee..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 diff --git a/exchange/exchange-ps/exchange/Enable-TransportRule.md b/exchange/exchange-ps/exchange/Enable-TransportRule.md index 2ac24f585d..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 diff --git a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md index 816334bb3a..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 diff --git a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md index c5fe92c26c..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 diff --git a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md b/exchange/exchange-ps/exchange/Enable-UMIPGateway.md index f44b963275..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 diff --git a/exchange/exchange-ps/exchange/Enable-UMMailbox.md b/exchange/exchange-ps/exchange/Enable-UMMailbox.md index d617cdc8ed..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 diff --git a/exchange/exchange-ps/exchange/Enable-UMServer.md b/exchange/exchange-ps/exchange/Enable-UMServer.md index fb0c6919d9..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 diff --git a/exchange/exchange-ps/exchange/Enable-UMService.md b/exchange/exchange-ps/exchange/Enable-UMService.md index a683409a77..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 diff --git a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md index 71f96638de..8da13825b6 100644 --- a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md +++ b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/execute-azureadlabelsync +online version: https://learn.microsoft.com/powershell/module/exchange/execute-azureadlabelsync applicable: Security & Compliance title: Execute-AzureADLabelSync schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Execute-AzureADLabelSync ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 PowerShell, you need to be assigned 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 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 823fcbb839..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 diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md index f01ef0d4ae..8d5bf12471 100644 --- a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md +++ b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-activityexplorerdata -applicable: Exchange Online, Security & Compliance +online version: https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata +applicable: Security & Compliance title: Export-ActivityExplorerData schema: 2.0.0 author: chrisda @@ -12,16 +12,16 @@ ms.reviewer: # Export-ActivityExplorerData ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 -StartTime +Export-ActivityExplorerData -EndTime -OutputFormat -StartTime [-Filter1 ] [-Filter2 ] [-Filter3 ] @@ -33,64 +33,221 @@ Export-ActivityExplorerData -EndTime -StartTime ``` ## 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://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +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 +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. +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" +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. 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. +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 -Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageCookie 'JZDRkpowAEV%2fZYfn6hIQCr4tCwEdoQWT4OalAyQVJEAKUtRO%2f31ZvM%2fnnjtz%2fyneTVb9HVUNV7bK91frVVM17cXaaputAV7eQuWbEmZFWbU8yham002jkqxqs0Y1V3xgq2lcqWA98eE6Dtq6EN3IMinX2WPs%2bbromllxLPpOiJ07990WAnraG8QvRV5Twfyoe3%2f7itOO00rCNvmJsfiDvOmKBbsyYNeFb7gUwzKsvYX0urPNHKpyLNNEdxxM4DUjyQWJ0mB%2bskMqdJ7KR3ojQ3pSuyk87VGcAoQacCUtxQWCQe6Rmk0LCLP9jsBWxETsKUkTF5%2fYiT3KmHvgB65hEAbFonxfyYPu0JoHSYhg0hUkGnJUlhG0jBRTk7el%2fgQPpe2H6YF8qDGgt%2bhBk7zxjNw9qxglkqCoi%2bOF7P0dl7CBAgOWRb74i5ubSC%2bJ%2bQG6eyxgE7XP7fAC6S9n3kjl7yOQPYb7KdYsIwJ2gC5n4%2bjZzvx2kA0lZ%2fHI%2b%2ft8uK5urM3Gtk1L%2bf8J' +$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. +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") +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, and filters the output by the Activity value FileArchived. +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") +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, and filters the output by the Activity value FileArchived or ArchiveCreated. +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") +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, and filters the output by the Workload value Enpoint for FileArchived or ArchiveCreated activities. +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". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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 +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 @@ -102,13 +259,13 @@ 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". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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 +Applicable: Security & Compliance Required: True Position: Named @@ -124,13 +281,13 @@ If you specify multiple filter values for the same parameter, OR behavior is use 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`). +`-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: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -148,7 +305,7 @@ Use this parameter only if you're also using the Filter1 parameter in the same c Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -166,7 +323,7 @@ Use this parameter only if you're also using the Filter2 and Filter1 parameters Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -184,7 +341,7 @@ Use this parameter only if you're also using the Filter3, Filter2, and Filter1 p Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -202,7 +359,7 @@ Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -212,13 +369,13 @@ 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 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: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -228,13 +385,13 @@ 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. +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: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: False Position: Named @@ -251,5 +408,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 52f0cdbcd9..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 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 be0e0cb728..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,7 +33,7 @@ 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 @@ -82,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 diff --git a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md index 6cebc73783..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,7 +56,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md b/exchange/exchange-ps/exchange/Export-FilePlanProperty.md index 8b39ae99d7..91b4a41f26 100644 --- a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md +++ b/exchange/exchange-ps/exchange/Export-FilePlanProperty.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-fileplanproperty +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md index 56801f8cca..0b68ce68f7 100644 --- a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md +++ b/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-journalrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/export-journalrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Export-JournalRuleCollection schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-JournalRuleCollection cmdlet to export the journal rules in your organization to an XML 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 @@ -32,7 +32,7 @@ Export-JournalRuleCollection [[-Identity] ] ## 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 diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md index 4ddc2f9d0e..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 @@ -114,6 +116,7 @@ The ComponentName parameter specifies the component that you want to retrieve th - OOFRules - RBA - RemindersAssistant +- Sharing - SharingMigrationAssistant - SharingSyncAssistant - SubstrateHoldTracking @@ -191,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 diff --git a/exchange/exchange-ps/exchange/Export-Message.md b/exchange/exchange-ps/exchange/Export-Message.md index 469cba12b4..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 diff --git a/exchange/exchange-ps/exchange/Export-MigrationReport.md b/exchange/exchange-ps/exchange/Export-MigrationReport.md index 6fb1a9a8de..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 ] [] ``` @@ -35,47 +39,60 @@ Export-QuarantineMessage -Identities [-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[] @@ -122,13 +139,36 @@ Accept wildcard characters: False ``` ### -CompressOutput -{{ Fill CompressOutput Description }} +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 +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 @@ -138,13 +178,71 @@ Accept wildcard characters: False ``` ### -ForceConversionToMime -{{ Fill ForceConversionToMime Description }} +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 +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 @@ -154,13 +252,13 @@ Accept wildcard characters: False ``` ### -RecipientAddress -{{ Fill RecipientAddress Description }} +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md index bca9aa14bf..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 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. 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,7 +41,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md index f1ec94496c..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,9 +33,9 @@ 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 diff --git a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md b/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md index 3fb69a0053..29e7f3790d 100644 --- a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md +++ b/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-umcalldatarecord -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +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 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Export-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 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 @@ -35,7 +35,7 @@ The Export-UMCallDataRecord cmdlet exports Unified Messaging call data records f 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 @@ -62,7 +62,7 @@ The ClientStream parameter specifies the .NET stream to use to output for the Un Type: Stream 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 @@ -78,7 +78,7 @@ The Date parameter specifies the date of Unified Messaging call data records to Type: ExDateTime 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 @@ -97,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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -107,8 +107,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 @@ -131,7 +129,7 @@ The UMDialPlan parameter specifies the UM dial plan to export statistics for. If 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 @@ -147,7 +145,7 @@ The UMIPGateway parameter specifies the UM IP gateway to export statistics for. 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 @@ -163,7 +161,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 Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Export-UMPrompt.md b/exchange/exchange-ps/exchange/Export-UMPrompt.md index befc20f680..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,7 +43,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-ADPermission.md b/exchange/exchange-ps/exchange/Get-ADPermission.md index 4b36aaab84..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 diff --git a/exchange/exchange-ps/exchange/Get-ADServerSettings.md b/exchange/exchange-ps/exchange/Get-ADServerSettings.md index 3757c7c7f6..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 diff --git a/exchange/exchange-ps/exchange/Get-ADSite.md b/exchange/exchange-ps/exchange/Get-ADSite.md index 2e05d05ead..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 diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md index da7f3ff2cd..714d4981eb 100644 --- a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule +applicable: Exchange Online title: Get-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,9 +25,9 @@ Get-ATPBuiltInProtectionRule [[-Identity] ] [-Stat ``` ## DESCRIPTION -For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -75,7 +75,7 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -89,12 +89,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md index 3c886034e1..f0a24d140f 100644 --- a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule +applicable: Exchange Online title: Get-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-ATPProtectionPolicyRule [[-Identity] ] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -82,7 +82,7 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md index abfa764dc5..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,11 +51,11 @@ TotalMissedSafeAttachmentCount is when the recipient or tenant is not included i 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. +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 @@ -103,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 @@ -137,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 @@ -203,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 diff --git a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md index 350525e882..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,6 +84,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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md index 1e0e89245c..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 @@ -16,9 +16,9 @@ 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. -**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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -69,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 @@ -84,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 @@ -106,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 diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md index 150eff50d0..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). +- 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: diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md index 3734af5c52..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). +- 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: diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md index 8389fab87f..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,12 +59,13 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md index f25ae54c3c..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 diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md index 31c4c26b1d..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 diff --git a/exchange/exchange-ps/exchange/Get-ActivityAlert.md b/exchange/exchange-ps/exchange/Get-ActivityAlert.md deleted file mode 100644 index bee038f426..0000000000 --- a/exchange/exchange-ps/exchange/Get-ActivityAlert.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activityalert -applicable: Security & Compliance -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 PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. 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 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 Purview compliance portal](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 - -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 a6a1a5f432..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 diff --git a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md index 728381c7f3..1444986464 100644 --- a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-adaptivescope -applicable: Security & Compliance +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 @@ -12,20 +12,23 @@ ms.reviewer: # Get-AdaptiveScope ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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] ] [] +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://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 +58,7 @@ The Identity parameter specifies the adaptive scope that you want to view. You c Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online, Security & Compliance Required: False Position: 0 @@ -64,6 +67,38 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md index a454520cd3..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 diff --git a/exchange/exchange-ps/exchange/Get-AddressList.md b/exchange/exchange-ps/exchange/Get-AddressList.md index ca40616193..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 diff --git a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md index dc274ae2ce..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 diff --git a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md index 59d80e4247..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 diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md index 083df891b6..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 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -40,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 @@ -54,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) diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md deleted file mode 100644 index 43de0a406b..0000000000 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md +++ /dev/null @@ -1,217 +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. - -**Note**: This cmdlet will be deprecated. Use the [Get-ContentMalwareMdoDetailReport](https://docs.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport) cmdlet instead. - -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. - -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 ea7ce33d8b..0000000000 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md +++ /dev/null @@ -1,257 +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. - -**Note**: This cmdlet will be deprecated. Use the [Get-ContentMalwareMdoAggregateReport](https://docs.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport) cmdlet instead. - -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. - -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 -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 -- Direction -- Domain -- EventType - -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 ef82f905f5..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 diff --git a/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md similarity index 51% rename from exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md rename to exchange/exchange-ps/exchange/Get-AggregateZapReport.md index 89c51cbd03..fd62052590 100644 --- a/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md @@ -1,90 +1,109 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-cspstnusagedetailreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-aggregatezapreport applicable: Exchange Online -title: Get-CsPSTNUsageDetailReport +title: Get-AggregateZapReport schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: --- -# Get-CsPSTNUsageDetailReport +# Get-AggregateZapReport ## 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-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. -Use the Get-CsPSTNUsageDetailReport cmdlet to view public switched telephone network (PSTN) usage details for Skype for Business Online 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 ``` -Get-CsPSTNUsageDetailReport [-EndDate ] - [-ResultSize ] - [-StartDate ] +Get-AggregateZapReport + [[-EndDate] ] + [[-Page] ] + [[-PageSize] ] + [[-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: +For the reporting period you specify, the cmdlet returns the following information: -- SipUri -- DateTimeOfCall -- TelephoneNumber -- CallID -- CallType -- Location -- CallDuration -- Currency -- CallCharge +- 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-CsPSTNUsageDetailReport -StartDate 11/01/2015 -EndDate 12/30/2015 +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 shows the PSTN usage detail for users in November and December. +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, or you can enter the date and time of 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. 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: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False -Position: Named +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 ``` -### -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. +### -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: Unlimited +Type: Int32 Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False -Position: Named -Default value: None +Position: 3 +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -92,18 +111,20 @@ 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". + +If you use this parameter, you also need to use the StartDate parameter. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False -Position: Named +Position: 4 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md index 0aa9937ade..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -77,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 @@ -117,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 diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md b/exchange/exchange-ps/exchange/Get-AntiPhishRule.md index 1e53971e8b..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-App.md b/exchange/exchange-ps/exchange/Get-App.md index b55635c53f..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) diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md index 33e0ae03e5..1feb6b2100 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy applicable: Security & Compliance title: Get-AppRetentionCompliancePolicy schema: 2.0.0 @@ -12,25 +12,26 @@ ms.reviewer: # Get-AppRetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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, Yammer chats, and Yammer 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. +\*-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://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,10 +44,10 @@ This example returns a summary list of all app retention compliance policies. ### Example 1 ```powershell -Get-AppRetentionCompliancePolicy -Identity "Contoso Yammer" +Get-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" ``` -This example returns detailed information for the app retention compliance policy named Contoso Yammer. +This example returns detailed information for the app retention compliance policy named Contoso Viva Engage. ## PARAMETERS @@ -86,6 +87,22 @@ 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. diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md index 83e35b96e6..b61fb71ac0 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancerule applicable: Security & Compliance title: Get-AppRetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-AppRetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AppRetentionComplianceRule to view app retention compliance 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 @@ -25,7 +25,7 @@ Get-AppRetentionComplianceRule [[-Identity] ] [-Polic ``` ## 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://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,10 +38,10 @@ This example returns a summary list of all app retention compliance rules. ### Example 1 ```powershell -Get-AppRetentionComplianceRule -Identity "Contoso Yammer" +Get-AppRetentionComplianceRule -Identity "Contoso Viva Engage" ``` -This example returns detailed information for the app retention compliance rule named Contoso Yammer. +This example returns detailed information for the app retention compliance rule named Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md index c1af32d347..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 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 4956787003..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -56,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 diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md index 768038fcd8..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. diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md index fdd551a0d9..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 diff --git a/exchange/exchange-ps/exchange/Get-AuditConfig.md b/exchange/exchange-ps/exchange/Get-AuditConfig.md index 41f39f6236..65476171dc 100644 --- a/exchange/exchange-ps/exchange/Get-AuditConfig.md +++ b/exchange/exchange-ps/exchange/Get-AuditConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-auditconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-auditconfig applicable: Security & Compliance title: Get-AuditConfig schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-AuditConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md deleted file mode 100644 index 409ed7cf38..0000000000 --- a/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md +++ /dev/null @@ -1,91 +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 -title: Get-AuditConfigurationPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 - -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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 c8acad8303..0000000000 --- a/exchange/exchange-ps/exchange/Get-AuditConfigurationRule.md +++ /dev/null @@ -1,91 +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 -title: Get-AuditConfigurationRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 - -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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 9b797cfec2..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 diff --git a/exchange/exchange-ps/exchange/Get-AuthConfig.md b/exchange/exchange-ps/exchange/Get-AuthConfig.md index 8fa97d89bf..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 diff --git a/exchange/exchange-ps/exchange/Get-AuthRedirect.md b/exchange/exchange-ps/exchange/Get-AuthRedirect.md index ebc7bceb9b..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 diff --git a/exchange/exchange-ps/exchange/Get-AuthServer.md b/exchange/exchange-ps/exchange/Get-AuthServer.md index d207e6852d..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 diff --git a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md index d3cf149a5d..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,6 +74,49 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md index fff47f122a..b60b6db4da 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy applicable: Security & Compliance title: Get-AutoSensitivityLabelPolicy schema: 2.0.0 @@ -12,24 +12,25 @@ ms.reviewer: # Get-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,8 +79,29 @@ 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 -{{ Fill IncludeProgressFeedback Description }} +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 diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md index fa3a17004c..ebaea6d9d6 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule applicable: Security & Compliance title: Get-AutoSensitivityLabelRule schema: 2.0.0 @@ -12,17 +12,18 @@ ms.reviewer: # Get-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,6 +81,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeExecutionRuleGuids The IncludeExecutionRuleGuids parameter specifies whether to include the execution rule GUID in the rule details. Valid values are: diff --git a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md index e4ab4884b2..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 diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md index 525b138a14..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 diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md index 17ac1ddc50..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 diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md index 87302c7291..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 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 64fe16f9b1..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 ### Input types -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. +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 ### 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://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. +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 1766668a94..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 @@ -193,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 @@ -227,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). +- 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 diff --git a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md index 51635421bc..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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -79,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 @@ -111,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). +- 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 diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md index 306aad9740..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" ``` @@ -87,6 +88,7 @@ For basic analysis of the items, don't include the DetailLevel parameter, or use ### 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)} ``` @@ -119,7 +121,7 @@ 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 calender items to analyze, use the CalendarLogs parameter. +**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. diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md index 888e27de31..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 @@ -16,7 +16,7 @@ Although this cmdlet is available in on-premises Exchange and in the cloud-based 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 @@ -150,7 +150,7 @@ In the location you specify, a subfolder is automatically created for the specif 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 @@ -169,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 @@ -247,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 @@ -283,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 @@ -430,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 diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md index b1c9504aa0..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,12 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] @@ -30,6 +32,7 @@ Get-CalendarDiagnosticObjects [-Identity] [-ExactMatch ] [-ItemClass ] [-ItemIds ] + [-MaxResults ] [-MeetingId ] [-ODataId ] [-ResultSize ] @@ -53,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 @@ -67,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. @@ -116,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 }} @@ -133,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,7 +188,7 @@ Accept wildcard characters: False ### -EndDate 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 @@ -257,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,7 +429,7 @@ Accept wildcard characters: False ### -StartDate 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 diff --git a/exchange/exchange-ps/exchange/Get-CalendarNotification.md b/exchange/exchange-ps/exchange/Get-CalendarNotification.md index 7d4f5ff444..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 @@ -133,7 +119,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 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 @@ -143,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 diff --git a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md b/exchange/exchange-ps/exchange/Get-CalendarProcessing.md index ccc3e600f4..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 diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md index d27c18a1ca..54654c842b 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-caseholdpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy applicable: Security & Compliance title: Get-CaseHoldPolicy schema: 2.0.0 @@ -12,13 +12,11 @@ ms.reviewer: # Get-CaseHoldPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch. -**Note**: This cmdlet doesn't work if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-CaseHoldPolicy [[-Identity] ] ``` ## 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://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 diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md index 9734792185..632e20fe65 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-caseholdrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdrule applicable: Security & Compliance title: Get-CaseHoldRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md index 07491f8bcb..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 @@ -18,7 +18,7 @@ Use the Get-ClassificationRuleCollection cmdlet to view the classification rule 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 diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md index 69601506b5..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 diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessService.md b/exchange/exchange-ps/exchange/Get-ClientAccessService.md index 7a72c6aa1d..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 diff --git a/exchange/exchange-ps/exchange/Get-Clutter.md b/exchange/exchange-ps/exchange/Get-Clutter.md index 293f428d64..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,17 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -66,6 +67,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md index 52c4d75f10..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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/exchange/Get-ComplianceCase.md index 653ef7f821..74d35075bf 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancecase +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecase applicable: Security & Compliance title: Get-ComplianceCase schema: 2.0.0 @@ -12,13 +12,11 @@ ms.reviewer: # Get-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. See the CaseType parameter for a list of these case types. -**Note**: This cmdlet doesn't work if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-ComplianceCase [-Identity] ] ``` ## 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://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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md index fd64f8ba46..5588971c20 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancecasemember +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecasemember applicable: Security & Compliance title: Get-ComplianceCaseMember schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 @@ -38,7 +38,7 @@ Get-ComplianceCaseMember ``` ## 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://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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md index f2d45a2019..4688db4274 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEvent +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent applicable: Security & Compliance title: Get-ComplianceRetentionEvent schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceRetentionEvent ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md index de10185da3..413b3c7aa3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype applicable: Security & Compliance title: Get-ComplianceRetentionEventType schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md index 91f676a151..95ca1983f2 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancesearch +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,6 +75,8 @@ 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) @@ -91,7 +93,7 @@ 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 eDiscovery Standard 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 eDiscovery Premium cases. diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md index 9a138cefe8..a0ca0a62b5 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancesearchaction +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 @@ -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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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. @@ -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. @@ -206,6 +212,24 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Preview The Preview switch filters the results by Preview compliance search actions. You don't need to specify a value with this switch. @@ -225,7 +249,7 @@ 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. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md index 64a77904ac..0c3ff1f88a 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter +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 @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. 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 @@ -32,7 +32,7 @@ Get-ComplianceSecurityFilter [-Action ] ## DESCRIPTION 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,11 +55,11 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTag.md b/exchange/exchange-ps/exchange/Get-ComplianceTag.md index 654402516b..2c704b8488 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancetag +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetag applicable: Exchange Online, Security & Compliance title: Get-ComplianceTag schema: 2.0.0 @@ -12,22 +12,23 @@ ms.reviewer: # Get-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 ``` Get-ComplianceTag [[-Identity] ] [-IncludingLabelState] + [-PriorityCleanup] [] ``` ## 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://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 @@ -83,6 +84,22 @@ 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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md index 5958f736fc..c3aa8eaca3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancetagstorage +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetagstorage applicable: Exchange Online, Security & Compliance title: Get-ComplianceTagStorage schema: 2.0.0 @@ -12,21 +12,22 @@ ms.reviewer: # Get-ComplianceTagStorage ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,6 +62,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md index 80547927c9..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,9 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -74,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 @@ -124,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 diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md index 6ae7cc1d48..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,9 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,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. @@ -74,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 @@ -124,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. A value for this parameter can't be older than 30 days. diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md index b189571b77..ff118bc38d 100644 --- a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md +++ b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation +applicable: Exchange Online title: Get-ConfigAnalyzerPolicyRecommendation schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ 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. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.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 @@ -30,7 +28,7 @@ Get-ConfigAnalyzerPolicyRecommendation -RecommendedPolicyType ] - [-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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 b2d60567f9..0000000000 --- a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.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-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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 index 574af2763c..97f9d3efd2 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-connectioninformation +online version: https://learn.microsoft.com/powershell/module/exchange/get-connectioninformation applicable: Exchange Online title: Get-ConnectionInformation schema: 2.0.0 @@ -13,20 +13,53 @@ ms.reviewer: # Get-ConnectionInformation ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview7 or later. 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 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 the counterpart to Get-PSSession used with Remote PowerShell Sessions. This cmdlet is available only in version 2.0.6-Preview7 or later. +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 @@ -37,8 +70,64 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-Contact.md b/exchange/exchange-ps/exchange/Get-Contact.md index 3215c9e467..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). +- 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,27 +184,6 @@ 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. diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md index 51c3a58e03..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 diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md index 2ae4a50e82..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md index 0876083dce..2c884d0e2f 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport +applicable: Exchange Online title: Get-ContentMalwareMdoAggregateReport schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ For the specified reporting period, the cmdlet returns the following information 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 @@ -67,7 +67,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -79,13 +79,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/2021 to specify September 1, 2021. +Use the short date format that's defined in the Regional Options settings on the computer where 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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -101,7 +101,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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -117,7 +117,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -129,13 +129,13 @@ 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. +Use the short date format that's defined in the Regional Options settings on the computer where 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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -157,7 +157,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md index 5c618360ea..eb99b53c05 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport +applicable: Exchange Online title: Get-ContentMalwareMdoDetailReport schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ For the specified reporting period, the cmdlet returns the following information 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -81,13 +81,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/2021 to specify September 1, 2021. +Use the short date format that's defined in the Regional Options settings on the computer where 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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -103,7 +103,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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -119,7 +119,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -131,13 +131,13 @@ 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. +Use the short date format that's defined in the Regional Options settings on the computer where 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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -159,7 +159,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-CsAVConferenceTimeReport.md b/exchange/exchange-ps/exchange/Get-CsAVConferenceTimeReport.md deleted file mode 100644 index 43987595b8..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsAVConferenceTimeReport.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-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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 da34d508f2..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsActiveUserReport.md +++ /dev/null @@ -1,140 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 0ee98b6263..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsClientDeviceDetailReport.md +++ /dev/null @@ -1,133 +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. - -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 40dd3744cd..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsClientDeviceReport.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-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. - -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 d5b42b00a0..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsConferenceReport.md +++ /dev/null @@ -1,140 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 3adce9c181..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsP2PAVTimeReport.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-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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 44bb51d117..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsP2PSessionReport.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-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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 5967c0f422..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsPSTNConferenceTimeReport.md +++ /dev/null @@ -1,129 +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. - -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-CsUserActivitiesReport.md b/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md deleted file mode 100644 index 058fdfb07a..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md +++ /dev/null @@ -1,153 +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. - -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 b5b27e1e7f..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsUsersBlockedReport.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-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. - -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-CustomNudge.md b/exchange/exchange-ps/exchange/Get-CustomNudge.md deleted file mode 100644 index 0776e82a3f..0000000000 --- a/exchange/exchange-ps/exchange/Get-CustomNudge.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-customnudge -applicable: Exchange Online -title: Get-CustomNudge -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Get-CustomNudge - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Get-CustomNudge cmdlet to view Custom Nudges that are displayed in user Briefing email 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). - -## SYNTAX - -``` -Get-CustomNudge [-Name ] - [-ResultSize ] - [] -``` - -## DESCRIPTION -Custom Nudges that are assigned to users appear their Briefing email messages. Users can mark Custom Nudges as complete after they finish the task. - -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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Get-CustomNudge | Format-Table Name,Title,From -``` - -This example returns a summary list all Custom Nudges in the organization. - -### Example 2 -```powershell -Get-CustomNudge -Name Nudge 01 -``` - -This example returns detailed information for the Custom Nudge named Nudge 01. - -## PARAMETERS - -### -Name -The Name parameter specifies the name of the Custom Nudge that you want to view. 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 -``` - -### -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 - -[Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin) diff --git a/exchange/exchange-ps/exchange/Get-CustomNudgeAssignment.md b/exchange/exchange-ps/exchange/Get-CustomNudgeAssignment.md deleted file mode 100644 index f8d4360e40..0000000000 --- a/exchange/exchange-ps/exchange/Get-CustomNudgeAssignment.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-customnudgeassignment -applicable: Exchange Online -title: Get-CustomNudgeAssignment -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Get-CustomNudgeAssignment - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Get-CustomNudgeAssignment to view the assignments of Custom Nudges to users. Custom Nudges are shown in the Briefing 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). - -## SYNTAX - -``` -Get-CustomNudgeAssignment [-AssigneeId ] [-NudgeName ] - [-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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Get-CustomNudgeAssignment -NudgeName perfReviewNudge -``` - -This example returns all assignments that contain the Custom Nudge named perfReviewNudge. - -### Example 2 -```powershell -Get-CustomNudgeAssignment -AssigneeId roy@contoso.onmicrosoft.com -``` - -This example returns all assignments that contain the user roy@contoso.onmicrosoft.com. - -### Example 3 -```powershell -Get-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId roy@contoso.onmicrosoft.com -``` - -This example returns the StartTime and EndTime values for the assignment of the Custom Nudge named perfReviewNudge to the user roy@contoso.com. - -## PARAMETERS - -### -AssigneeId -The AssigneeId parameter specifies the email address of the user that you want to view. - -If you use this parameter without the NudgeName parameter, all Custom Nudges that are assigned to the user are returned. - -If you use this parameter with the NudgeName parameter, the StartDate and EndDate values of the assignment are returned. - -```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 -``` - -### -NudgeName -The NudgeName parameter filters the assignments by the name of the Custom Nudge. If the value contains spaces, enclose the value in quotation marks ("). - -If you use this parameter without the AssigneeId parameter, all users who have the Custom Nudge assigned to them are returned. - -If you use this parameter with the AssigneeId parameter, the StartDate and EndDate values of the assignment are returned. - -```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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-CustomNudgeSettings.md b/exchange/exchange-ps/exchange/Get-CustomNudgeSettings.md deleted file mode 100644 index 58742c493b..0000000000 --- a/exchange/exchange-ps/exchange/Get-CustomNudgeSettings.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-customnudgesettings -applicable: Exchange Online -title: Get-CustomNudgeSettings -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Get-CustomNudgeSettings - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Get-CustomNudgeSettings cmdlet to view the organization settings for Custom Nudges. Custom Nudges are shown in the Briefing 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). - -## SYNTAX - -``` -Get-CustomNudgeSettings - [-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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Get-CustomNudgeSettings -``` - -This example returns the Custom Nudge settings for the organization. - -### -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/Get-DataClassification.md b/exchange/exchange-ps/exchange/Get-DataClassification.md index d2df73ed89..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 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS 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 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,6 +102,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md b/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md index 119c143a0d..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md index 4e2b852835..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Data encryption policy cmdlets are the Exchange Online part of Customer Key. For 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 @@ -53,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. @@ -88,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. diff --git a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md index f2d30938f5..1f38d8c687 100644 --- a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md +++ b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dataretentionreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-dataretentionreport applicable: Exchange Online, Security & Compliance title: Get-DataRetentionReport schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DataRetentionReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 @@ -38,7 +38,7 @@ The following properties are returned by this cmdlet: - DataSource - MessageCount -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://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 +54,7 @@ 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 @@ -104,7 +104,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". + +The StartDate value can't be older than 92 days from today. ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md index 988b67ba1a..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,35 +58,35 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md index 9848274656..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 ``` 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 10478e033d..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 ``` 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 b594106a6a..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. diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md index 85c12d51cf..a79926c166 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy applicable: Exchange Online, Security & Compliance title: Get-DeviceConditionalAccessPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md index cf002334a5..65fe845674 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule applicable: Exchange Online, Security & Compliance title: Get-DeviceConditionalAccessRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md index c1279728ac..34e6dc1ae0 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy applicable: Exchange Online, Security & Compliance title: Get-DeviceConfigurationPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md index 29b5219bba..84afa08d75 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule applicable: Exchange Online, Security & Compliance title: Get-DeviceConfigurationRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConfigurationRule ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DevicePolicy.md b/exchange/exchange-ps/exchange/Get-DevicePolicy.md index acf727176f..f7cb5c1dce 100644 --- a/exchange/exchange-ps/exchange/Get-DevicePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DevicePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-devicepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-devicepolicy applicable: Exchange Online, Security & Compliance title: Get-DevicePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DevicePolicy ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md index df19ed5c5c..ce5c1c516e 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-devicetenantpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantpolicy applicable: Exchange Online, Security & Compliance title: Get-DeviceTenantPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md index dabe27604a..3d61488bdc 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-devicetenantrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantrule applicable: Exchange Online, Security & Compliance title: Get-DeviceTenantRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceTenantRule ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 +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 +Applicable: Security & Compliance Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroup.md b/exchange/exchange-ps/exchange/Get-DistributionGroup.md index ee8f5d227d..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 @@ -138,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 @@ -172,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). +- 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 @@ -219,6 +237,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 +``` + ### -ManagedBy The ManagedBy parameter filters the results by the owner of the group. You can use any value that uniquely identifies the owner. For example: diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md index 0edf5125e6..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 diff --git a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md index 022b2ac91c..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md index 9b622a2c47..f5a379ed1b 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy applicable: Security & Compliance title: Get-DlpCompliancePolicy schema: 2.0.0 @@ -12,24 +12,29 @@ ms.reviewer: # Get-DlpCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 +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 @@ -84,9 +89,27 @@ 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) @@ -100,6 +123,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeExtendedProperties {{ Fill IncludeExtendedProperties Description }} @@ -116,6 +155,54 @@ 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 }} diff --git a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md index 958360af07..3ec06ed550 100644 --- a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancerule applicable: Security & Compliance title: Get-DlpComplianceRule schema: 2.0.0 @@ -12,23 +12,24 @@ ms.reviewer: # Get-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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 }} diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md index c04870fa90..ec4460246a 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpdetailreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetailreport applicable: Exchange Online, Security & Compliance title: Get-DlpDetailReport schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Get-DlpDetailReport ## SYNOPSIS +**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. + This cmdlet is available only in the cloud-based service. -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. +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 @@ -56,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 @@ -150,7 +152,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 @@ -229,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. @@ -250,7 +252,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 diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md index 03f7d089c3..be1c5ba605 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport applicable: Exchange Online, Security & Compliance title: Get-DlpDetectionsReport schema: 2.0.0 @@ -14,9 +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. -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-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,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 @@ -140,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: DateTime @@ -244,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. @@ -265,7 +267,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 diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md index 004d67cee0..d9052762b8 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema applicable: Security & Compliance title: Get-DlpEdmSchema schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -76,4 +76,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 66bdae04d9..cf21bb85d5 100644 --- a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary applicable: Exchange Online, Security & Compliance title: Get-DlpKeywordDictionary schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicy.md b/exchange/exchange-ps/exchange/Get-DlpPolicy.md index d81c4c7004..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 @@ -68,8 +70,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 diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md index bd3492e80f..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md index dd0325a215..99d0a14db7 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype applicable: Exchange Online, Security & Compliance title: Get-DlpSensitiveInformationType schema: 2.0.0 @@ -12,16 +12,17 @@ ms.reviewer: # Get-DlpSensitiveInformationType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,6 +69,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md index ec76bd608b..b89d2416f2 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport applicable: Exchange Online, Security & Compliance title: Get-DlpSiDetectionsReport schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Get-DlpSiDetectionsReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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). + +**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. 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 @@ -36,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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 +61,7 @@ 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 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 a0f9ebe8fc..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. diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md index 11dfd99ae2..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). +- 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 @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md index 1ad3696082..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] ] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md index c51f98a7c7..72e7aca6f2 100644 --- a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.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-exocasmailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-exocasmailbox applicable: Exchange Online title: Get-EXOCasMailbox schema: 2.0.0 @@ -13,11 +13,11 @@ 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). +- 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[] diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/exchange/Get-EXOMailbox.md index 6acc7f223d..fb1295de5f 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailbox.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-exomailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailbox applicable: Exchange Online title: Get-EXOMailbox schema: 2.0.0 @@ -13,11 +13,11 @@ 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). +- 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[] diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md index 9818e4aa16..d15ff5ab3c 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.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-exomailboxfolderpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission applicable: Exchange Online title: Get-EXOMailboxFolderPermission schema: 2.0.0 @@ -13,11 +13,11 @@ 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 @@ -185,10 +185,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 73c1893e5c..b6d21cf8d8 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.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-exomailboxfolderstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics applicable: Exchange Online title: Get-EXOMailboxFolderStatistics schema: 2.0.0 @@ -13,11 +13,11 @@ 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 @@ -85,11 +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. Valid values are: - -- ExternalDirectoryObjectId -- Identity -- UserPrincipalName +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -105,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. @@ -183,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 ``` diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md index d8002a4131..d008aa8f24 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.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-exomailboxpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxpermission applicable: Exchange Online title: Get-EXOMailboxPermission schema: 2.0.0 @@ -13,11 +13,11 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md index 519ab1dde9..cbe03cc816 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.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-exomailboxstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxstatistics applicable: Exchange Online title: Get-EXOMailboxStatistics schema: 2.0.0 @@ -13,11 +13,11 @@ 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[] diff --git a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md index 1d2f014a5c..91b5ebab64 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.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-exomobiledevicestatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics applicable: Exchange Online title: Get-EXOMobileDeviceStatistics schema: 2.0.0 @@ -13,11 +13,11 @@ 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 @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EXORecipient.md b/exchange/exchange-ps/exchange/Get-EXORecipient.md index 333eead941..fd34b10f9d 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipient.md +++ b/exchange/exchange-ps/exchange/Get-EXORecipient.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-exorecipient +online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipient applicable: Exchange Online title: Get-EXORecipient schema: 2.0.0 @@ -13,11 +13,11 @@ 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). +- 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 diff --git a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md index e6b0343096..3ec37b7a9d 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.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-exorecipientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipientpermission applicable: Exchange Online title: Get-EXORecipientPermission schema: 2.0.0 @@ -13,11 +13,11 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md index 53dedeb072..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 diff --git a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md b/exchange/exchange-ps/exchange/Get-EdgeSubscription.md index 2442106113..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md index 3a79fc4e54..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 diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md index f6bf9facfa..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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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,41 +48,41 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md b/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md index 9e1507d140..025fdca73a 100644 --- a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md +++ b/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-emailtenantsettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-emailtenantsettings applicable: Exchange Online title: Get-EmailTenantSettings schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## 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://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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-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 3c2f7e53de..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,24 +107,6 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md index 8ea2ae5679..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 diff --git a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md index 28bfaabb12..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md index 0731a2a50c..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 diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md index 961c205e13..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 ``` 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 f589c0e8c5..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. diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md index 5c79215c53..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 diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md index 2c667bf8eb..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 diff --git a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md index 7e26aa04fc..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. @@ -216,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. diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md index 198800b2a6..08f6210738 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy +applicable: Exchange Online title: Get-ExoInformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -16,16 +16,16 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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] [] +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 Exchange Online information barrier policy Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -78,7 +78,7 @@ When you use this switch, the following property values are shown: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md index 432de2f2d8..8e1ddb9d25 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship +applicable: Exchange Online title: Get-ExoInformationBarrierRelationship schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-ExoInformationBarrierRelationship -RecipientId1 -Reci ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 RecipientId1 parameter specifies the first recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -76,7 +76,7 @@ The RecipientId2 parameter specifies the second recipient in the Exchange Online Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md index 51c889ee69..b0caf1efcb 100644 --- a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment +applicable: Exchange Online title: Get-ExoInformationBarrierSegment schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-ExoInformationBarrierSegment [[-Identity] ] +Get-ExoPhishSimOverrideRule [[-Identity] ] [-Confirm] + [-DomainController ] [-Policy ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 -Get-PhishSimOverrideRule +Get-ExoPhishSimOverrideRule ``` -This example returns detailed information about the one and only phishing simulation override rule. +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 @@ -50,14 +60,16 @@ The Identity parameter specifies the phishing simulation override rule that you - 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, Security & Compliance +Applicable: Exchange Online Required: False -Position: 0 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False @@ -70,7 +82,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -107,7 +119,7 @@ The Policy parameter filters the results by phishing simulator override policy. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -123,7 +135,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md similarity index 54% rename from exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md index f324ce40e9..4f8ca933c6 100644 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md +++ b/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md @@ -1,44 +1,54 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-secopsoverriderule -applicable: Exchange Online, Security & Compliance -title: Get-SecOpsOverrideRule +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-SecOpsOverrideRule +# Get-ExoSecOpsOverrideRule ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -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). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-SecOpsOverrideRule [[-Identity] ] +Get-ExoSecOpsOverrideRule [[-Identity] ] [-Confirm] + [-DomainController ] [-Policy ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 -Get-SecOpsOverrideRule +Get-ExoSecOpsOverrideRule ``` -This example returns detailed information about the one and only SecOps mailbox override rule. +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 @@ -50,14 +60,16 @@ The Identity parameter specifies the SecOps override rule that you want to view. - 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, Security & Compliance +Applicable: Exchange Online Required: False -Position: 0 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False @@ -70,7 +82,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -107,7 +119,7 @@ The Policy parameter filters the results by SecOps mailbox override policy. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -123,7 +135,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md b/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md index 1782fd9b70..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md index 2940a24eba..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 @@ -16,7 +16,7 @@ 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 @@ -213,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 @@ -283,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 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 c204984dab..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 diff --git a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md index 011d319a10..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,37 +50,37 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-FederationInformation.md b/exchange/exchange-ps/exchange/Get-FederationInformation.md index dc7b7583d9..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 diff --git a/exchange/exchange-ps/exchange/Get-FederationTrust.md b/exchange/exchange-ps/exchange/Get-FederationTrust.md index a7cbec03eb..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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md index 7be4f2480a..023b70021a 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertyauthority +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md index a2671e6f81..c7b0bab4ef 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertycategory +https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertycategory applicable: Security & Compliance title: Get-FilePlanPropertyCategory schema: 2.0.0 @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertyCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Fet-FilePlanPropertyCategory cmdlet to view 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md index 3fdfbd764f..9080e6137a 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyCitation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation applicable: Security & Compliance title: Get-FilePlanPropertyCitation schema: 2.0.0 @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertyCitation ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-FilePlanPropertyCitation cmdlet to view 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md index ea1ff345ac..58fc2c7f5e 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyDepartment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertydepartment +online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertydepartment applicable: Security & Compliance title: Get-FilePlanPropertyDepartment schema: 2.0.0 @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertyDepartment ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-FilePlanPropertyDepartment cmdlet to view 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md index 51603c7205..c1ec2f310a 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyReferenceId.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertyreferenceid +online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertyreferenceid applicable: Security & Compliance title: Get-FilePlanPropertyReferenceId schema: 2.0.0 @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertyReferenceId ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-FilePlanPropertyReferenceId cmdlet to view 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md index eb21d7c8ab..f2e64f89a2 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyStructure.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertystructure +online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertystructure applicable: Security & Compliance title: Get-FilePlanPropertyStructure schema: 2.0.0 @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertyStructure ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-FilePlanPropertyStructure cmdlet to the view file plan property structure 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md index 7a1ce2c450..ed2bc3113e 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertysubcategory +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Get-FocusedInbox.md b/exchange/exchange-ps/exchange/Get-FocusedInbox.md index 0c09b291b0..c7b5967c67 100644 --- a/exchange/exchange-ps/exchange/Get-FocusedInbox.md +++ b/exchange/exchange-ps/exchange/Get-FocusedInbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.Management-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-focusedinbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-focusedinbox applicable: Exchange Online, Exchange Online Protection title: Get-FocusedInbox schema: 2.0.0 @@ -16,19 +16,20 @@ This cmdlet is available only in the cloud-based service. Use the Get-FocusedInbox cmdlet to view the Focused Inbox configuration 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 ``` Get-FocusedInbox -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 @@ -68,6 +69,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-ForeignConnector.md b/exchange/exchange-ps/exchange/Get-ForeignConnector.md index 893a6ca05d..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 diff --git a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md b/exchange/exchange-ps/exchange/Get-FrontendTransportService.md index 60bdb7ba94..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,6 +72,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md b/exchange/exchange-ps/exchange/Get-GlobalAddressList.md index 9279979568..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,26 +113,6 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md index 212cffa6a1..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 diff --git a/exchange/exchange-ps/exchange/Get-Group.md b/exchange/exchange-ps/exchange/Get-Group.md index 935177eed2..b940181519 100644 --- a/exchange/exchange-ps/exchange/Get-Group.md +++ b/exchange/exchange-ps/exchange/Get-Group.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-group +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 @@ -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 @@ -128,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 @@ -164,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). +- 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 @@ -260,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. diff --git a/exchange/exchange-ps/exchange/Get-GroupActivityReport.md b/exchange/exchange-ps/exchange/Get-GroupActivityReport.md deleted file mode 100644 index 40b297fbca..0000000000 --- a/exchange/exchange-ps/exchange/Get-GroupActivityReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 bb0b3cec51..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 diff --git a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md b/exchange/exchange-ps/exchange/Get-HistoricalSearch.md index 3fde90043f..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md index ff15934b2f..ec353acb7a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy applicable: Security & Compliance title: Get-HoldCompliancePolicy schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Get-HoldCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 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 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md index 184abd65c3..898c6c476a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancerule applicable: Security & Compliance title: Get-HoldComplianceRule schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Get-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md index 27018ae044..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md index 04f205bb21..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md b/exchange/exchange-ps/exchange/Get-HybridConfiguration.md index 53d43a3e84..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 diff --git a/exchange/exchange-ps/exchange/Get-HybridMailflow.md b/exchange/exchange-ps/exchange/Get-HybridMailflow.md deleted file mode 100644 index d73849d09f..0000000000 --- a/exchange/exchange-ps/exchange/Get-HybridMailflow.md +++ /dev/null @@ -1,56 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 10d0eb7408..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,7 +16,7 @@ This cmdlet is available only in the cloud-based service. This 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 diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md b/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md index fd98a73691..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 diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md index e80bc6bf77..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md index 7909e767d8..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md index 7b55e943e7..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 diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md b/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md index c8a1c92c45..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 diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md index f2000a99bb..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 diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md index a022279aea..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md index aa64d52b5e..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 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 11a049c35d..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 diff --git a/exchange/exchange-ps/exchange/Get-ImapSettings.md b/exchange/exchange-ps/exchange/Get-ImapSettings.md index a364cd3e99..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 diff --git a/exchange/exchange-ps/exchange/Get-InboundConnector.md b/exchange/exchange-ps/exchange/Get-InboundConnector.md index 36a13616e1..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,19 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -64,6 +65,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/exchange/Get-InboxRule.md index 7688d562c7..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,7 +51,7 @@ 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. @@ -83,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 @@ -95,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 @@ -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,6 +252,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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md index af8c7ec93b..4ba383b667 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus +online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus applicable: Security & Compliance title: Get-InformationBarrierPoliciesApplicationStatus schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-InformationBarrierPoliciesApplicationStatus ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -101,4 +101,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 4ed4bf8253..32c2276297 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy applicable: Security & Compliance title: Get-InformationBarrierPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -107,6 +107,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 c38da81cd2..862519808e 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus +online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus applicable: Security & Compliance title: Get-InformationBarrierRecipientStatus schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Get-InformationBarrierRecipientStatus ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,8 +116,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 8486f383af..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 diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md index 21c5b258a6..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/exchange/Get-Label.md index d1ce7367df..b2cf3b4226 100644 --- a/exchange/exchange-ps/exchange/Get-Label.md +++ b/exchange/exchange-ps/exchange/Get-Label.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-label +online version: https://learn.microsoft.com/powershell/module/exchange/get-label applicable: Security & Compliance title: Get-Label schema: 2.0.0 @@ -12,23 +12,24 @@ ms.reviewer: # Get-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,13 +70,10 @@ Accept wildcard characters: False ``` ### -IncludeDetailedLabelActions -The IncludeDetailedLabelActions parameter specifies whether to expand label actions into properties for better readability. Valid values are: - -- $true: Include detailed label actions. -- $false: Don't include detailed label actions. +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 @@ -103,6 +101,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-LabelPolicy.md b/exchange/exchange-ps/exchange/Get-LabelPolicy.md index 6b8307522c..7a90fbaa71 100644 --- a/exchange/exchange-ps/exchange/Get-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-LabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-labelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-labelpolicy applicable: Security & Compliance title: Get-LabelPolicy schema: 2.0.0 @@ -12,21 +12,22 @@ ms.reviewer: # Get-LabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -66,6 +67,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md b/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md deleted file mode 100644 index e4a7107d1f..0000000000 --- a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md +++ /dev/null @@ -1,61 +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). - -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 73e50ae35b..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,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-LinkedUser cmdlet to view existing linked 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 @@ -41,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 @@ -61,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: @@ -84,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). +- 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 @@ -108,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. diff --git a/exchange/exchange-ps/exchange/Get-LogonStatistics.md b/exchange/exchange-ps/exchange/Get-LogonStatistics.md index 5759cb4132..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 @@ -16,7 +16,7 @@ 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: diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md index e120a92635..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-MailContact.md b/exchange/exchange-ps/exchange/Get-MailContact.md index 9e5b8d9287..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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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,29 +181,6 @@ 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. diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md index 60091d7259..5b27ac86dc 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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,10 +52,11 @@ For the reporting period you specify, the cmdlet returns the following informati - Domain - Subject - Message Size -- Direction: Values are Inbound, Outbound, 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. +- 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 @@ -63,7 +64,7 @@ For the reporting period you specify, the cmdlet returns the following informati 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 @@ -93,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 @@ -127,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 @@ -166,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 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"`. @@ -334,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 diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md index 6dba76570b..370e827191 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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -72,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 @@ -122,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 @@ -288,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 diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md index cc4f5f284d..218a792389 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-maildetailencryptionreport -applicable: Exchange Online, Security & Compliance +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 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 you append the command with ` | Format-List`, the following additional inform - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,7 +89,7 @@ The AggregateBy parameter specifies the reporting period. Valid values are Hour, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -99,13 +99,18 @@ 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -121,7 +126,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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -133,13 +138,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: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -162,7 +167,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -180,7 +185,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -206,7 +211,7 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -222,7 +227,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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -238,7 +243,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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -254,7 +259,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -266,13 +271,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: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md index 7962a76dcb..8c7caa8477 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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -71,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 @@ -105,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 @@ -270,7 +275,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". Although you can enter a date up to 30 days old, only data from the last 10 days is returned. diff --git a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md b/exchange/exchange-ps/exchange/Get-MailFilterListReport.md index 2c250c4ad2..4fe3fbe363 100644 --- a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md +++ b/exchange/exchange-ps/exchange/Get-MailFilterListReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailfilterlistreport +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 @@ -16,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md index 109047e421..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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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 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: +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. -- 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 diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md index cfd5267edd..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-MailTrafficATPReport [-ProbeTag ] [-StartDate ] [-SummarizeBy ] + [-ThreatClassification ] [] ``` @@ -51,7 +52,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Verdict Source - 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 @@ -106,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 @@ -143,9 +150,9 @@ The EndDate parameter specifies the end of the date range in Coordinated Univers 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). -If you use the EndDate parameter, you must also use the StartDate parameter. +If you use this parameter, you also need to use the StartDate parameter. ```yaml Type: DateTime @@ -184,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 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"`. @@ -287,9 +294,9 @@ The StartDate parameter specifies the start of the date range in Coordinated Uni 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). -If you use the StartDate parameter, you must also use the EndDate parameter. +If you use this parameter, you also need to use the EndDate parameter. ```yaml Type: DateTime @@ -329,6 +336,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md index b403454be3..8fe274f754 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport -applicable: Exchange Online, Security & Compliance +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 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ For the reporting period you specify, the cmdlet returns the following informati - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -84,7 +84,7 @@ The AggregateBy parameter specifies the reporting period. Valid values are Hour, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -94,13 +94,18 @@ 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 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -116,7 +121,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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -128,13 +133,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: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -157,7 +162,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -173,7 +178,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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -189,7 +194,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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -205,7 +210,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -217,13 +222,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: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -247,7 +252,7 @@ You can specify multiple values separated by commas. When you specify the values Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md index 52b98133a5..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -110,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 @@ -160,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 @@ -254,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 diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md index 08e566ebd6..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -54,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 @@ -104,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 @@ -170,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 diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md deleted file mode 100644 index 177185f021..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. - -**Note**: This cmdlet is in the process of being deprecated. Use the [Get-MailTrafficSummaryReport](https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport) cmdlet instead. - -Use the Get-MailTrafficTopReport cmdlet to view a report of the highest volume senders, recipients, malware recipients and spam recipients 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). - -## 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. - -For this cmdlet, 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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 b1ffbcf8ad..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 @@ -52,8 +52,33 @@ Get-MailUser [[-Identity] ] [] ``` +### 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 @@ -73,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: @@ -100,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 @@ -122,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 @@ -134,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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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,26 +206,21 @@ 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 ``` @@ -193,7 +236,7 @@ This switch enables the command to access Active Directory objects that aren't c ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -204,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: @@ -236,7 +297,7 @@ By default, the recipient scope is set to the domain that hosts your Exchange se ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -272,7 +333,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: AnrSet, Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md index fe5822cb21..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). +- 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,35 +444,6 @@ 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. @@ -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. @@ -623,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. @@ -651,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. @@ -700,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 @@ -716,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. @@ -760,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. diff --git a/exchange/exchange-ps/exchange/Get-MailboxActivityReport.md b/exchange/exchange-ps/exchange/Get-MailboxActivityReport.md deleted file mode 100644 index eaac81af68..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxActivityReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 796bbbc932..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 @@ -157,6 +158,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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md index d4856bfa84..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,6 +137,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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md index 9ef9210edc..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,6 +106,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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-MailboxDatabase.md b/exchange/exchange-ps/exchange/Get-MailboxDatabase.md index bfc2a5d854..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. diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md index c559d90d52..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. @@ -137,22 +153,6 @@ 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. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md index bfec07dbfc..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md index c9c392df01..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolder.md b/exchange/exchange-ps/exchange/Get-MailboxFolder.md index d0c69704ce..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md index 05ce459a3b..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 @@ -163,10 +227,10 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 eb89e93131..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,6 +352,60 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md index 2a7b0a6c14..ca07bcdfd7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md +++ b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxirmaccess +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxirmaccess applicable: Exchange Online title: Get-MailboxIRMAccess schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Get-MailboxIRMAccess [[-Identity] ] ## 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 returns information about delegate access to IRM-protected messages Get-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com ``` -This example returns information about delegate Chris' access access to IRM-protected messages in Lynette's mailbox. +This example returns information about delegate Chris' access to IRM-protected messages in Lynette's mailbox. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md index 0d127dc977..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md index 6165f8f9b3..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 @@ -66,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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md index 5a8aab0c89..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 @@ -40,9 +40,9 @@ The junk email settings on the mailbox are: - 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 @@ -56,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 ``` @@ -97,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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxLocation.md b/exchange/exchange-ps/exchange/Get-MailboxLocation.md index c81059b6ef..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md index ef818b8590..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,6 +26,8 @@ Get-MailboxMessageConfiguration [-Identity] [-DomainController ] [-ReadFromDomainController] [-ResultSize ] + [-SignatureName ] + [-UseCustomRouting] [] ``` @@ -35,7 +37,7 @@ The Get-MailboxMessageConfiguration cmdlet shows Outlook on the web settings for > [!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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 +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 @@ -154,6 +156,42 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-MailboxPermission.md b/exchange/exchange-ps/exchange/Get-MailboxPermission.md index b95cebb2a5..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] [] ``` @@ -41,8 +43,10 @@ Get-MailboxPermission [-Identity] [-User ] + [-UseCustomRouting] [] ``` @@ -65,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 @@ -122,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 @@ -211,6 +215,24 @@ 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. @@ -285,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: @@ -292,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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxPlan.md b/exchange/exchange-ps/exchange/Get-MailboxPlan.md index 802db52740..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -97,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 @@ -113,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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md index b6fb45ade7..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. diff --git a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md index df2eb58830..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 ``` @@ -149,6 +151,24 @@ 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 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. @@ -201,24 +221,6 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md index 2853aadde4..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md index 46d8464e47..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 @@ -62,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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/exchange/Get-MailboxSearch.md index 3abb7f02b0..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 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. diff --git a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md index 95cdd29a0d..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxServer.md b/exchange/exchange-ps/exchange/Get-MailboxServer.md index 49d5ebb04b..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md index 457b60d062..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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md index b487451c08..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 ``` @@ -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). +- 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'`. @@ -443,6 +448,24 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md b/exchange/exchange-ps/exchange/Get-MailboxTransportService.md index ade8f5b0ff..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md b/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md deleted file mode 100644 index 4d95cef803..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md +++ /dev/null @@ -1,113 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 fb5346c5cb..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md +++ /dev/null @@ -1,113 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 ac648aa0a5..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 diff --git a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md index 974a6408da..fef6949dce 100644 --- a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md +++ b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md @@ -1,27 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] @@ -41,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 @@ -67,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 @@ -83,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 @@ -95,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. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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 @@ -126,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 @@ -142,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 @@ -158,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 @@ -174,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 @@ -186,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. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For 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 diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md index a3a0fb0408..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md index cda3de3f11..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md index 593c1b7f54..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md index 6975ee2011..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,24 +118,6 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolder.md b/exchange/exchange-ps/exchange/Get-ManagedFolder.md index ed59d717af..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md index eaecd2d8f3..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-ManagementRole.md b/exchange/exchange-ps/exchange/Get-ManagementRole.md index 6b86016ed5..72a4c467e8 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRole.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managementrole +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 @@ -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 @@ -231,7 +231,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md index 00a6311220..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 @@ -362,7 +364,7 @@ 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 @@ -377,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 ("). diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md index 53ca743b14..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. diff --git a/exchange/exchange-ps/exchange/Get-ManagementScope.md b/exchange/exchange-ps/exchange/Get-ManagementScope.md index 9ec6c32cd3..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,22 +117,6 @@ 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 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. diff --git a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md index d38246dd14..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-Message.md b/exchange/exchange-ps/exchange/Get-Message.md index 6e5174c81d..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 ("). @@ -227,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. diff --git a/exchange/exchange-ps/exchange/Get-MessageCategory.md b/exchange/exchange-ps/exchange/Get-MessageCategory.md index 0336c73d5b..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 diff --git a/exchange/exchange-ps/exchange/Get-MessageClassification.md b/exchange/exchange-ps/exchange/Get-MessageClassification.md index d11abd943b..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 diff --git a/exchange/exchange-ps/exchange/Get-MessageTrace.md b/exchange/exchange-ps/exchange/Get-MessageTrace.md index b9a85f9931..9c5967a9f2 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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ By default, this cmdlet returns a maximum of 1000 results, and will timeout on v 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ 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 @@ -218,7 +218,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 diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md index 6a1bcef1de..716d8c1509 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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -74,7 +74,7 @@ The MessageTraceId value is also available in the output of the following cmdlet Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -90,7 +90,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -108,7 +108,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 @@ -120,7 +120,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". If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. @@ -128,7 +128,7 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,7 +154,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 @@ -170,7 +170,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 @@ -186,7 +186,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 @@ -202,7 +202,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 @@ -218,7 +218,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 @@ -234,7 +234,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 @@ -246,7 +246,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". If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. @@ -254,7 +254,7 @@ If don't use the StartDate and EndDate parameters, only data from the last 48 ho Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md new file mode 100644 index 0000000000..9fe086bc52 --- /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-MessageTrace 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 9fca9f55f6..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 diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md index adc202e1bb..e123a060c9 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 @@ -18,7 +18,7 @@ Use the Get-MessageTrackingReport cmdlet to return data for a specific message t In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail 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. diff --git a/exchange/exchange-ps/exchange/Get-MigrationBatch.md b/exchange/exchange-ps/exchange/Get-MigrationBatch.md index 0a61d9bbc0..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 ] + [-ResultSize ] + [] +``` + +### BatchesByStatus +``` +Get-MigrationBatch + [-DiagnosticInfo ] [-IncludeReport] [-Partition ] - [-Status ] + [-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,34 +99,34 @@ This example displays information about all migration batches associated with th ## PARAMETERS -### -Diagnostic -This parameter is available only in on-premises Exchange. - -The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. +### -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. -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 @@ -115,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 @@ -160,7 +182,7 @@ Typically, you use the DiagnosticInfo parameter only at the request of Microsoft ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: Applicable: Exchange Online @@ -171,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 @@ -189,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 ``` @@ -232,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 @@ -263,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 diff --git a/exchange/exchange-ps/exchange/Get-MigrationConfig.md b/exchange/exchange-ps/exchange/Get-MigrationConfig.md index 6c6c594d35..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 diff --git a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md index 4d0609e83d..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. @@ -191,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. diff --git a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationStatistics.md index 3444ae16da..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 diff --git a/exchange/exchange-ps/exchange/Get-MigrationUser.md b/exchange/exchange-ps/exchange/Get-MigrationUser.md index e0e2cefde3..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 diff --git a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md index af7842b6af..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 @@ -173,6 +174,24 @@ 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. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-MobileDevice.md b/exchange/exchange-ps/exchange/Get-MobileDevice.md index 435dcf81e4..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,7 +55,7 @@ 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 @@ -166,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). +- 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: diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md index c7a9331a04..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md index 984cbb3f90..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,13 +48,14 @@ 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 @@ -67,12 +69,13 @@ This example retrieves the statistics for the specified mobile phone. ### Example 2 ```powershell $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 @@ -266,6 +269,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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md index efcab16715..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 diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md b/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md index 94c36a1f4a..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 diff --git a/exchange/exchange-ps/exchange/Get-MoveRequest.md b/exchange/exchange-ps/exchange/Get-MoveRequest.md index ef8a88e048..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. diff --git a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md index abafa2e202..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. diff --git a/exchange/exchange-ps/exchange/Get-MxRecordReport.md b/exchange/exchange-ps/exchange/Get-MxRecordReport.md index 8164fc1322..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md index 94818802d9..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md b/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md index ef754dfc99..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-Notification.md b/exchange/exchange-ps/exchange/Get-Notification.md index 803c03606c..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 diff --git a/exchange/exchange-ps/exchange/Get-O365ClientBrowserDetailReport.md b/exchange/exchange-ps/exchange/Get-O365ClientBrowserDetailReport.md deleted file mode 100644 index 96bdf6f45e..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientBrowserDetailReport.md +++ /dev/null @@ -1,184 +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. - -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 d4eea439bc..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientBrowserReport.md +++ /dev/null @@ -1,146 +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. - -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 8fe9c8b35c..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientOSDetailReport.md +++ /dev/null @@ -1,183 +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. - -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 21ca7b0a0d..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientOSReport.md +++ /dev/null @@ -1,145 +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. - -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 ff80bec6b7..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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-OMEConfiguration cmdlet to view Microsoft Purview Message Encryption configurations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -53,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 diff --git a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md index e947c02698..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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-OMEMessageStatus cmdlet to view the Microsoft Purview Message Encryption revocation status for a specific 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,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 diff --git a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md index cb3c99af35..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: @@ -123,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. diff --git a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md index c375387344..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,28 +132,6 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md index 988c67dd93..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -61,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 diff --git a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md b/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md index 1f28ec0e54..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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md b/exchange/exchange-ps/exchange/Get-OrganizationConfig.md index 10ff307e6d..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 diff --git a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md index 7ed72e79d0..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md index accf871813..12687a5a45 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-organizationsegment +online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationsegment applicable: Security & Compliance title: Get-OrganizationSegment schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-OrganizationSegment ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,8 +85,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 9e43b29513..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 diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnector.md b/exchange/exchange-ps/exchange/Get-OutboundConnector.md index bcaaefc642..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,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 @@ -105,6 +106,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md b/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md index a710030d53..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md index 17fbd03ce3..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 diff --git a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md index f4650234c1..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-OutlookProvider.md b/exchange/exchange-ps/exchange/Get-OutlookProvider.md index 04518a3a56..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md index 2d4a76dd97..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md index eb55cfa1e8..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 diff --git a/exchange/exchange-ps/exchange/Get-PartnerApplication.md b/exchange/exchange-ps/exchange/Get-PartnerApplication.md index cddc0eff18..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 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 11cf0bd36e..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 diff --git a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md b/exchange/exchange-ps/exchange/Get-PerimeterConfig.md index 69656bd969..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX diff --git a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md deleted file mode 100644 index f732a74188..0000000000 --- a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md +++ /dev/null @@ -1,208 +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. - -**Note**: This cmdlet is in the process of being deprecated. Use the \*-TenantAllowBlockListSpoofItems, Get-SpoofIntelligenceInsight, and Get-SpoofMailReport cmdlets instead. - -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. - -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 56833100f2..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: Exchange Online, Security & Compliance +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 functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-Place.md b/exchange/exchange-ps/exchange/Get-Place.md index ef8c061e70..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,12 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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] +Get-Place [[-Identity] ] + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +### AllPlaces +``` +Get-Place [-Type ] [-Confirm] [-ResultSize ] [-WhatIf] @@ -29,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 @@ -47,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 @@ -59,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) @@ -104,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. diff --git a/exchange/exchange-ps/exchange/Get-PolicyConfig.md b/exchange/exchange-ps/exchange/Get-PolicyConfig.md index c157bae21e..7b985e28c4 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Get-PolicyConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-policyconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-policyconfig applicable: Security & Compliance title: Get-PolicyConfig schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-PolicyConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -25,7 +25,7 @@ Get-PolicyConfig [[-Identity] ] [] ``` ## 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://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,7 +39,7 @@ This example returns the endpoint restrictions that are available in the organiz ## PARAMETERS ### -Identity -{{ Fill Identity Description }} +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter diff --git a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md index fd0311d00f..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. diff --git a/exchange/exchange-ps/exchange/Get-PopSettings.md b/exchange/exchange-ps/exchange/Get-PopSettings.md index 772a8b7f36..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 diff --git a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md index a2f5d99301..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 diff --git a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md index bb9eeda949..2e99bc420c 100644 --- a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-protectionalert +online version: https://learn.microsoft.com/powershell/module/exchange/get-protectionalert applicable: Security & Compliance title: Get-ProtectionAlert schema: 2.0.0 @@ -12,21 +12,22 @@ ms.reviewer: # Get-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -66,6 +67,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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-PublicFolder.md b/exchange/exchange-ps/exchange/Get-PublicFolder.md index 86388e1425..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. diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md index b712f8c337..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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md index 912c8ea477..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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md index 9a5cfe845c..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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md index ede6b7af06..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. diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md index e3b4396b49..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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md index a5901acf53..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`). diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md index 2cf1f4a859..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 @@ -61,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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md index 8009045a5f..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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md index 5875d3a52a..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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md index 4a733410fc..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 @@ -140,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 @@ -163,7 +186,7 @@ The IncludeReport switch specifies whether to return additional details, which c 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 @@ -172,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 ``` @@ -197,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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md index 55688aafb5..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index ee440e2814..7e98a8ee18 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessage +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 @@ -16,24 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] @@ -46,24 +51,25 @@ Get-QuarantineMessage [-Direction ] [-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 @@ -114,10 +120,15 @@ 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, Exchange Online Protection @@ -130,7 +141,7 @@ 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[] @@ -148,12 +159,12 @@ 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, Exchange Online Protection @@ -168,10 +179,47 @@ 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: System.DateTime +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 +``` + +### -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: DateTime +Type: SwitchParameter Parameter Sets: Summary Aliases: Applicable: Exchange Online, Security & Compliance, Exchange Online Protection @@ -272,9 +320,10 @@ The PolicyTypes parameter filters the results by the type of protection policy t - AntiMalwarePolicy - AntiPhishPolicy +- DataLossPreventionRule - ExchangeTransportRule (mail flow rule) - HostedContentFilterPolicy (anti-spam policy) -- SafeAttachmentPolicy +- SafeAttachmentPolicy (Microsoft Defender for Office 365 only) You can specify multiple values separated by commas. @@ -295,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) @@ -306,7 +357,7 @@ 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[] @@ -338,13 +389,15 @@ Accept wildcard characters: False ``` ### -RecipientTag -{{ Fill RecipientTag Description }} +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -358,12 +411,16 @@ The ReleaseStatus parameter filters the results by the release status of the mes - 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 @@ -415,12 +472,12 @@ 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, Exchange Online Protection @@ -435,12 +492,12 @@ 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, Exchange Online Protection @@ -468,11 +525,36 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Type 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) @@ -483,7 +565,7 @@ 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, Exchange Online Protection diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index c6fc66f11b..9dac21f945 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessageheader +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 @@ -16,12 +16,13 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] [] ``` @@ -29,7 +30,7 @@ Get-QuarantineMessageHeader -Identity ## 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 @@ -43,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 ``` @@ -68,6 +70,27 @@ 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. @@ -75,7 +98,7 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md index 63501c55f5..93177a8f2a 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinepolicy applicable: Exchange Online, Exchange Online Protection title: Get-QuarantinePolicy schema: 2.0.0 @@ -16,20 +16,20 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] + [-QuarantinePolicyType ] [] ``` ## DESCRIPTION -Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 returns detailed information about the quarantine policy named NoAc Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy ``` -This example returns detailed information about the default quarantine policy named GlobalDefaultTag that controls the global quarantine notification (formerly known as end-user spam notification) settings. +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 @@ -80,10 +80,10 @@ Accept wildcard characters: False 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 GlobalDefaultTag. +- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named DefaultGlobalTag. ```yaml -Type: QuarantinePolicyTypeEnum +Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy diff --git a/exchange/exchange-ps/exchange/Get-Queue.md b/exchange/exchange-ps/exchange/Get-Queue.md index 0b86b17faa..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 ("). diff --git a/exchange/exchange-ps/exchange/Get-QueueDigest.md b/exchange/exchange-ps/exchange/Get-QueueDigest.md index 98db35e9fb..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 ("). diff --git a/exchange/exchange-ps/exchange/Get-RMSTemplate.md b/exchange/exchange-ps/exchange/Get-RMSTemplate.md index d6eabeb3f3..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 diff --git a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md index 8d2753cde6..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: diff --git a/exchange/exchange-ps/exchange/Get-Recipient.md b/exchange/exchange-ps/exchange/Get-Recipient.md index 07b8994de7..4b5a71f8b1 100644 --- a/exchange/exchange-ps/exchange/Get-Recipient.md +++ b/exchange/exchange-ps/exchange/Get-Recipient.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recipient +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 @@ -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: @@ -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,16 +304,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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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 @@ -302,29 +328,6 @@ 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, 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. @@ -364,6 +367,24 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeSoftDeletedRecipients The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch. @@ -508,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 @@ -520,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. diff --git a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md index 3554d2bb40..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-RecipientPermission.md b/exchange/exchange-ps/exchange/Get-RecipientPermission.md index 4e5ed9efde..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 diff --git a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md b/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md index 7ff0cfdbbc..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,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-RecipientStatisticsReport cmdlet to view the recipient statistics report. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md index 0f6f4726e6..4f413a8bf3 100644 --- a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recordreviewnotificationtemplateconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-recordreviewnotificationtemplateconfig applicable: Security & Compliance title: Get-RecordReviewNotificationTemplateConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-RecordReviewNotificationTemplateConfig cmdlet to view the record review notification and reminder 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 @@ -25,7 +25,7 @@ Get-RecordReviewNotificationTemplateConfig [] ``` ## 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://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 diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index 4021ab1392..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,15 +261,34 @@ 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: - DeletedItems: The Deleted Items folder. -- DiscoveryHoldsItems: 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. - 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 diff --git a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md index 23c4c71bde..69ceb96099 100644 --- a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-regulatorycomplianceui +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 PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-RemoteDomain.md b/exchange/exchange-ps/exchange/Get-RemoteDomain.md index 29f0d92729..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md index f5caea7ca1..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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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,33 +206,6 @@ 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 PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -272,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) diff --git a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md b/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md index ba673a8d6e..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 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 4f3ff75a60..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 diff --git a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md b/exchange/exchange-ps/exchange/Get-ResubmitRequest.md index f729dcc7e1..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 diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index be994a563b..fbb20052f5 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy applicable: Security & Compliance title: Get-RetentionCompliancePolicy schema: 2.0.0 @@ -12,18 +12,21 @@ ms.reviewer: # Get-RetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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. @@ -111,10 +130,44 @@ 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 +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. +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 diff --git a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md index b6b1bf4aa6..9c1279ce96 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancerule applicable: Security & Compliance title: Get-RetentionComplianceRule schema: 2.0.0 @@ -12,17 +12,18 @@ ms.reviewer: # Get-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -96,6 +97,22 @@ 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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Get-RetentionEvent.md b/exchange/exchange-ps/exchange/Get-RetentionEvent.md index e1452eab62..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,22 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -47,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. @@ -63,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 ``` diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md b/exchange/exchange-ps/exchange/Get-RetentionPolicy.md index 4102e9fe9b..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md index e7d4c81c85..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,37 +82,37 @@ 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 ``` 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 7518c19eac..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/exchange/Get-RoleGroup.md index 9af4e7ffa7..7e6cfdc324 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rolegroup +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 @@ -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 @@ -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). +- 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: diff --git a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md b/exchange/exchange-ps/exchange/Get-RoleGroupMember.md index f04caf4738..8416becc8f 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rolegroupmember +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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md index 497d9bfdba..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md b/exchange/exchange-ps/exchange/Get-RpcClientAccess.md index 299e2cd2a3..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 diff --git a/exchange/exchange-ps/exchange/Get-SCInsights.md b/exchange/exchange-ps/exchange/Get-SCInsights.md index 52da1026d1..7675f4455f 100644 --- a/exchange/exchange-ps/exchange/Get-SCInsights.md +++ b/exchange/exchange-ps/exchange/Get-SCInsights.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-scinsights +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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SCInsights cmdlet to view Microsoft 365 insights 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 @@ -34,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 @@ -60,7 +60,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md b/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md deleted file mode 100644 index 654d816a1a..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 28a327d461..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOSkyDriveProDeployedReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 eae5e8d71c..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOSkyDriveProStorageReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 5722bcf848..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOTeamSiteDeployedReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 6a027f7cfc..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOTeamSiteStorageReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 08f9a630ab..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOTenantStorageMetricReport.md +++ /dev/null @@ -1,130 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 88e09c3551..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -61,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 diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md index 791e49f1ac..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -62,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 @@ -78,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 diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md index 731e9b3361..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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ For the reporting period you specify, the cmdlet returns the following informati - 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 @@ -107,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. @@ -127,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. diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md index ffdfb3bece..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 @@ -16,12 +16,12 @@ This cmdlet is available only in the cloud-based service. 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] @@ -55,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 @@ -77,18 +77,18 @@ This example returns filters the results by the following information: ### -Action The Action parameter filters the results by action. Valid values are: -- Allowed -- Blocked -- ClickedDuringScan -- ClickedEvenBlocked -- Scanning -- TenantAllowed -- TenantBlocked -- TenantBlockedAndClickedThrough +- 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 that the values for this parameter are case sensitive. +**Note**: Values for this parameter are case sensitive. No data returned for an action implies that the action didn't occur. ```yaml Type: MultiValuedProperty @@ -146,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. @@ -216,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. diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md index b20fc25b1d..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -61,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 diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md index e8f6a65da5..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -62,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 @@ -78,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 diff --git a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md index 2a71752209..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 diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md index 65d7499719..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: Exchange Online, Security & Compliance +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 functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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: Exchange Online, Security & Compliance +Applicable: Exchange Online Required: False Position: 0 diff --git a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md b/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md index 9dd210c46a..458dcbe1b3 100644 --- a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md +++ b/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-securityprincipal +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 @@ -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,16 +104,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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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 @@ -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, 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. diff --git a/exchange/exchange-ps/exchange/Get-SendConnector.md b/exchange/exchange-ps/exchange/Get-SendConnector.md index d229713ff5..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 diff --git a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md index 742d0a315c..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md b/exchange/exchange-ps/exchange/Get-SenderIdConfig.md index a63d606487..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 diff --git a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md b/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md index 1cf2807095..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 diff --git a/exchange/exchange-ps/exchange/Get-ServerComponentState.md b/exchange/exchange-ps/exchange/Get-ServerComponentState.md index 0b66477c71..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 diff --git a/exchange/exchange-ps/exchange/Get-ServerHealth.md b/exchange/exchange-ps/exchange/Get-ServerHealth.md index 4162f2026c..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: diff --git a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md index 9eae5a4052..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 diff --git a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md b/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md index 8a96da2d39..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md index 7b9a22331f..ee06d9d363 100644 --- a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-serviceprincipal -applicable: Exchange Online +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 @@ -14,25 +14,24 @@ ms.reviewer: ## 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. +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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] ] - [-DomainController ] [-Organization ] [] ``` ## DESCRIPTION -Service principals exist in Azure Active Directory 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 Azure AD. To assign Exchange Online role-based access control (RBAC) roles to service principals in Azure AD, 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. +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 Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,14 +40,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-ServicePrincipal ``` -This example returns a summary list of all service principals. +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 ServiceId value ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. +This example returns detailed information about the service principal with the ObjectId value ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. ## PARAMETERS @@ -59,13 +58,13 @@ The Identity parameter specifies the service principal that you want to view. Yo - Distinguished name (DN) - GUID - AppId -- ServiceId +- ObjectId ```yaml Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -74,22 +73,6 @@ 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 -``` - ### -Organization This parameter is reserved for internal Microsoft use. @@ -97,7 +80,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-SettingOverride.md b/exchange/exchange-ps/exchange/Get-SettingOverride.md index 7d801b6976..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-SharingPolicy.md b/exchange/exchange-ps/exchange/Get-SharingPolicy.md index 8e3cf82da2..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 @@ -49,42 +49,42 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-SiteMailbox.md b/exchange/exchange-ps/exchange/Get-SiteMailbox.md index e3243e2a41..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 @@ -117,7 +117,7 @@ If you don't use this switch, and you aren't a member or owner of the site mailb 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,8 +161,6 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -This parameter is 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 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. @@ -177,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 @@ -193,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 diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md b/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md index a5e29996ff..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 @@ -86,7 +86,7 @@ If you don't use this switch and you aren't a member or owner of the site mailbo 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 diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md index 352ba560e4..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 diff --git a/exchange/exchange-ps/exchange/Get-SmimeConfig.md b/exchange/exchange-ps/exchange/Get-SmimeConfig.md index f1e287cacd..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 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 b0d28ef233..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,9 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -48,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 ``` diff --git a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md index bf33c4efef..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,7 +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). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -103,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 @@ -185,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 diff --git a/exchange/exchange-ps/exchange/Get-StaleMailboxDetailReport.md b/exchange/exchange-ps/exchange/Get-StaleMailboxDetailReport.md deleted file mode 100644 index 45daccaba0..0000000000 --- a/exchange/exchange-ps/exchange/Get-StaleMailboxDetailReport.md +++ /dev/null @@ -1,119 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 912455cfeb..0000000000 --- a/exchange/exchange-ps/exchange/Get-StaleMailboxReport.md +++ /dev/null @@ -1,113 +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. - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 72a86cddfa..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). +- 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 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md index dfeab85d8a..420045a251 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewActivity schema: 2.0.0 @@ -16,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,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. @@ -50,7 +49,7 @@ 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 @@ -84,7 +83,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 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md index 2adf8cea17..3a432c1505 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport applicable: Security & Compliance title: Get-SupervisoryReviewOverallProgressReport schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewOverallProgressReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,7 +45,7 @@ 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 @@ -95,7 +95,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 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md index 211abc79d6..d3982ce31b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewPolicyReport schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewPolicyReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 @@ -39,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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,7 +62,7 @@ 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 @@ -130,7 +130,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 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md index c4fd996b8c..cc356b57a5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewPolicyV2 schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md index d112421d3a..5e1a033aa5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewReport schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewReport ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 +54,7 @@ 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 @@ -140,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 diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md index fada0e98f1..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 +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule applicable: Exchange Online, Security & Compliance -title: Exchange Online, Get-SupervisoryReviewRule +title: Get-SupervisoryReviewRule schema: 2.0.0 author: chrisda ms.author: chrisda @@ -12,22 +12,23 @@ ms.reviewer: # Get-SupervisoryReviewRule ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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: diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md index 4984d84de1..f630b5e84b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport applicable: Security & Compliance title: Get-SupervisoryReviewTopCasesReport schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewTopCasesReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,7 +44,7 @@ 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 @@ -94,7 +94,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 diff --git a/exchange/exchange-ps/exchange/Get-SweepRule.md b/exchange/exchange-ps/exchange/Get-SweepRule.md index a0939b3394..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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 diff --git a/exchange/exchange-ps/exchange/Get-SystemMessage.md b/exchange/exchange-ps/exchange/Get-SystemMessage.md index a95fbce196..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. 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 0cd7294cb0..f2a8862ef7 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems +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 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS 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. +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 @@ -43,7 +43,7 @@ Get-TenantAllowBlockListItems -ListType [-NoExpiration] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 returns information for the specified file hash value. Get-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery ``` -This example returns information for all allowed third-party phishing simulation URLs. 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). +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 @@ -76,6 +76,7 @@ The ListType parameter specifies the list to view. Valid values are: - FileHash - Sender - Url +- IP ```yaml Type: ListType @@ -96,6 +97,7 @@ The Entry parameter filters the results based on the ListType parameter value. V - 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. @@ -135,7 +137,7 @@ The Allow switch filters the results for allow 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 @@ -166,7 +168,7 @@ 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 @@ -191,7 +193,7 @@ The ListSubType parameter filters the results by subtype. Valid values are: Type: ListSubType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md index 3094faacc3..a77fd3036a 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-tenantallowblocklistspoofitems +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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-TenantAllowBlockListSpoofItems cmdlet to view spoofed sender entries in the Tenant Allow/Block 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 @@ -36,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 @@ -62,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 ``` diff --git a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md index d3d516cbcd..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 diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md index 0befcb29a3..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,37 +54,37 @@ 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 ``` @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md index 9343852a22..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-TransportConfig.md b/exchange/exchange-ps/exchange/Get-TransportConfig.md index 568ba4d1cc..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-TransportPipeline.md b/exchange/exchange-ps/exchange/Get-TransportPipeline.md index c127f1ae52..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 diff --git a/exchange/exchange-ps/exchange/Get-TransportRule.md b/exchange/exchange-ps/exchange/Get-TransportRule.md index 7ef6a31a9a..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 diff --git a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md b/exchange/exchange-ps/exchange/Get-TransportRuleAction.md index 7773bafef2..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 diff --git a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md b/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md index 10a5d4d238..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 diff --git a/exchange/exchange-ps/exchange/Get-TransportServer.md b/exchange/exchange-ps/exchange/Get-TransportServer.md index 4edfde9b5e..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-TransportService.md b/exchange/exchange-ps/exchange/Get-TransportService.md index 604446b187..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-Trust.md b/exchange/exchange-ps/exchange/Get-Trust.md index b11e77d945..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 diff --git a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md index 0145f27969..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 diff --git a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md index 8a35edf522..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md index b6aa0b1594..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md b/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md index f60433f009..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 diff --git a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md index c99db35e78..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 diff --git a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md index ea458bc28d..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 diff --git a/exchange/exchange-ps/exchange/Get-UMDialPlan.md b/exchange/exchange-ps/exchange/Get-UMDialPlan.md index 934a914e2e..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md b/exchange/exchange-ps/exchange/Get-UMHuntGroup.md index 4ae05bc7d0..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMIPGateway.md b/exchange/exchange-ps/exchange/Get-UMIPGateway.md index ca528d274f..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,35 +61,35 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMMailbox.md b/exchange/exchange-ps/exchange/Get-UMMailbox.md index 0d6b401c3c..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). +- 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,33 +177,6 @@ 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 PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md b/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md index dcc2e91c54..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,30 +101,19 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md index 5ef2fe733a..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UMService.md b/exchange/exchange-ps/exchange/Get-UMService.md index bb5b02d1d6..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-UmServer.md b/exchange/exchange-ps/exchange/Get-UmServer.md index da1b2250d9..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 diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md index 179f22d554..07a961fcf8 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy applicable: Security & Compliance title: Get-UnifiedAuditLogRetentionPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. +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 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 Purview compliance portal](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"`. @@ -71,7 +71,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md index 8742048ca4..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,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 ] @@ -35,7 +40,12 @@ Get-UnifiedGroup [[-Identity] ] ``` Get-UnifiedGroup [-Anr ] [-Filter ] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAllProperties] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeRejectMessagesFromSendersOrMembersWithDisplayNames] [-IncludeSoftDeletedGroups] [-ResultSize ] [-SortBy ] @@ -45,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 @@ -92,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. @@ -99,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 @@ -109,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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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 @@ -133,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: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID +### -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. -**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 ``` @@ -167,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 @@ -185,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 @@ -201,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 @@ -225,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 diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md index af83d23091..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -56,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 @@ -66,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 @@ -93,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 diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/exchange/Get-User.md index 00541583a1..3cafe8aba0 100644 --- a/exchange/exchange-ps/exchange/Get-User.md +++ b/exchange/exchange-ps/exchange/Get-User.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-user +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 @@ -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,16 +250,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 in Exchange server, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). For more information about the filterable properties in Exchange Online and the EXO V2 module, see [Filters in the EXO V2 module](https://docs.microsoft.com/powershell/exchange/filters-v2). -- 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 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 @@ -250,27 +274,6 @@ 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: - -- Name -- 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 -``` - ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. @@ -294,12 +297,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeDirectReportsWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeDirectReportsWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IsVIP This parameter is available only in the cloud-based service. 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 @@ -381,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 diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md index 325cb6f533..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 @@ -85,4 +90,4 @@ Accept wildcard characters: False ## 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 fbee955f3f..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,9 +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. -**Note**: In Microsoft Graph, the [Get-MgUserPhoto](https://docs.microsoft.com/powershell/module/microsoft.graph.users/get-mguserphoto) and [Get-MgUserPhotoContent](https://docs.microsoft.com/powershell/module/microsoft.graph.users/get-mguserphotocontent) cmdlets are also 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 @@ -79,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: @@ -92,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 @@ -104,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 @@ -120,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 @@ -138,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). +- 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 @@ -169,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 @@ -178,33 +203,6 @@ 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 PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -217,7 +215,7 @@ This switch enables the command to access Active Directory objects that aren't c 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 @@ -238,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 @@ -254,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 @@ -272,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 @@ -292,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 @@ -308,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 @@ -328,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 diff --git a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md b/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md index 7fb4bcf05a..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 diff --git a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md index 6841f5b6eb..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,30 +12,36 @@ 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 @@ -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. 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 00b388d5aa..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 diff --git a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md index 21658d97f7..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 ``` diff --git a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md index facf870ae1..2af5f1721a 100644 --- a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin +online version: https://learn.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin applicable: Security & Compliance title: Get-eDiscoveryCaseAdmin schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md index 25d7a907c0..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,7 +36,7 @@ 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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md index 15c457f9b1..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,7 +28,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md index 660e8a79fc..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,16 +62,16 @@ 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 diff --git a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md b/exchange/exchange-ps/exchange/Import-FilePlanProperty.md index b53ece3fbb..0a64f7f630 100644 --- a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md +++ b/exchange/exchange-ps/exchange/Import-FilePlanProperty.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-fileplanproperty +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md index 52dd374db5..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,9 +33,9 @@ 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. -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). +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). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md index 71b48f7345..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 @@ -14,7 +14,9 @@ ms.reviewer: ## SYNOPSIS 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,9 +41,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md index d65b57978c..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,9 +34,9 @@ Import-TransportRuleCollection [[-Identity] ] [-FileData] -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 diff --git a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md index 1ca3504cac..dfc3b902a4 100644 --- a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md +++ b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite +online version: https://learn.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite applicable: Security & Compliance title: Install-UnifiedCompliancePrerequisite schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Install-UnifiedCompliancePrerequisite ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 PowerShell, you need to be assigned 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 diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md b/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md index 2fbb997476..d208ed10b8 100644 --- a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md +++ b/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep +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 @@ -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 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 d861153027..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 diff --git a/exchange/exchange-ps/exchange/Mount-Database.md b/exchange/exchange-ps/exchange/Mount-Database.md index db7acae4ce..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 diff --git a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md index 6c4821b610..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 diff --git a/exchange/exchange-ps/exchange/Move-AddressList.md b/exchange/exchange-ps/exchange/Move-AddressList.md index 116931d695..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) diff --git a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md index 7d4ff77105..85953675d6 100644 --- a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule +applicable: Exchange Online title: New-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -18,7 +18,7 @@ This cmdlet is available only in the cloud-based service. 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,12 +35,12 @@ New-ATPBuiltInProtectionRule -SafeAttachmentPolicy [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Profiles in preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#profiles-in-preset-security-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 name of the default Safe Attachments policy that's used for the Built-in pro Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -80,7 +80,7 @@ The name of the default Safe Links policy that's used for the Built-in protectio Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -96,7 +96,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 @@ -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 Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -125,13 +125,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 @@ -156,7 +156,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 @@ -183,7 +183,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 @@ -201,7 +201,7 @@ The name of the only rule is ATP Built-In Protection Rule. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -217,7 +217,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 diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md index 3735c799be..9397716f14 100644 --- a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule +applicable: Exchange Online title: New-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -16,9 +16,9 @@ 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 365 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. +**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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 +39,12 @@ New-ATPProtectionPolicyRule [-Name] -SafeAttachmentPolicy [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Profiles in preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#profiles-in-preset-security-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -78,7 +78,7 @@ 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 365 Defender portal, the name of the Safe Attachments policy will be one of the following values: +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`. @@ -89,7 +89,7 @@ You can find the Safe Attachments policy that's used by the Standard or Strict p Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -101,7 +101,7 @@ 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 365 Defender portal, the name of the Safe Attachments policy will be one of the following values: +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`. @@ -112,7 +112,7 @@ You can find the Safe Links policy that's used by the Standard or Strict preset Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -128,7 +128,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 @@ -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 Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -171,7 +171,7 @@ After you create the rule, you turn on or turn off the preset security policy us Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -181,13 +181,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 @@ -212,7 +212,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 @@ -239,7 +239,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 @@ -259,7 +259,7 @@ When you create the policy, you must use the default value. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -269,13 +269,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 @@ -300,7 +300,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 @@ -327,7 +327,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 @@ -343,7 +343,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 diff --git a/exchange/exchange-ps/exchange/New-AcceptedDomain.md b/exchange/exchange-ps/exchange/New-AcceptedDomain.md index f07f35548b..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 diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md index 5bfbb16167..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 diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md index 895f617514..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 diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md index 33f2c93bdd..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 diff --git a/exchange/exchange-ps/exchange/New-ActivityAlert.md b/exchange/exchange-ps/exchange/New-ActivityAlert.md deleted file mode 100644 index 041f40f1a2..0000000000 --- a/exchange/exchange-ps/exchange/New-ActivityAlert.md +++ /dev/null @@ -1,468 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-activityalert -applicable: Security & Compliance -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 PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. 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 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 Purview compliance portal](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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 -``` - -### -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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-AdaptiveScope.md b/exchange/exchange-ps/exchange/New-AdaptiveScope.md index cdc05b4407..88433a9deb 100644 --- a/exchange/exchange-ps/exchange/New-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/New-AdaptiveScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-adaptivescope +online version: https://learn.microsoft.com/powershell/module/exchange/new-adaptivescope applicable: Security & Compliance title: New-AdaptiveScope schema: 2.0.0 @@ -12,17 +12,18 @@ ms.reviewer: # New-AdaptiveScope ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] [] ``` @@ -30,20 +31,21 @@ New-AdaptiveScope -Name -FilterConditions -LocationType ### 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://docs.microsoft.com/microsoft-365/compliance/retention-settings#configuration-information-for-adaptive-scopes). +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://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-AdaptiveScope -Name "Project X" -LocationType User -FilterConditions @{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "CA"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "NotEquals"; "Name" = "Department"}); "Conjunction" = "And"} +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: @@ -72,7 +74,7 @@ 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" = "CA"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "NotEquals"; "Name" = "Department"}); "Conjunction" = "And"}` +- 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. @@ -112,7 +114,7 @@ Accept wildcard characters: False ``` ### -RawQuery -The RawQuery parameter switches the scope to advanced query mode. You use OPath filter syntax for advanced query mode. +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. @@ -129,6 +131,22 @@ 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". diff --git a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md b/exchange/exchange-ps/exchange/New-AddressBookPolicy.md index 164ddb0e6d..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 diff --git a/exchange/exchange-ps/exchange/New-AddressList.md b/exchange/exchange-ps/exchange/New-AddressList.md index 7303dd6e7e..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). +- 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 diff --git a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md index b83a7eb3a0..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 diff --git a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md index d64e7b2067..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, 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,7 +68,7 @@ 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 @@ -81,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 diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 0da41f28f6..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ New-AntiPhishPolicy [-Name] [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] [-Enabled ] [-EnableFirstContactSafetyTips ] [-EnableMailboxIntelligence ] @@ -40,6 +42,7 @@ New-AntiPhishPolicy [-Name] [-EnableViaTag ] [-ExcludedDomains ] [-ExcludedSenders ] + [-HonorDmarcPolicy ] [-ImpersonationProtectionState ] [-MailboxIntelligenceProtectionAction ] [-MailboxIntelligenceProtectionActionRecipients ] @@ -68,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 @@ -124,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. -- 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 @@ -159,6 +162,52 @@ 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 This parameter is reserved for internal Microsoft use. @@ -201,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: @@ -212,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 @@ -222,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: @@ -247,7 +296,7 @@ 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: @@ -268,7 +317,7 @@ 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: @@ -289,7 +338,7 @@ 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: @@ -331,7 +380,7 @@ 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: @@ -352,7 +401,7 @@ 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: @@ -382,8 +431,8 @@ The EnableUnauthenticatedSender parameter enables or disables unauthenticated se 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 @@ -399,7 +448,7 @@ 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: @@ -429,8 +478,8 @@ The EnableViaTag parameter enables or disables adding the via tag to the From ad 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 @@ -446,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 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) @@ -466,7 +517,7 @@ 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. @@ -485,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: @@ -508,15 +580,15 @@ 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. -- 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: 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. @@ -535,7 +607,7 @@ 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. @@ -555,7 +627,7 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceQuarantineTag -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 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: @@ -563,7 +635,11 @@ The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -597,7 +673,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: @@ -636,7 +712,7 @@ 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 @@ -674,7 +750,11 @@ The SpoofQuarantineTag specifies the quarantine policy that's used on messages t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -690,7 +770,7 @@ 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. @@ -710,15 +790,15 @@ 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: - 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. -- 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: 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 @@ -735,7 +815,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainQuarantineTag -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 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: @@ -743,7 +823,11 @@ The TargetedDomainQuarantineTag specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -759,7 +843,7 @@ 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. @@ -779,7 +863,7 @@ 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. @@ -799,15 +883,15 @@ 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: - 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. -- 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: 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 @@ -824,7 +908,7 @@ Accept wildcard characters: False ``` ### -TargetedUserQuarantineTag -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 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: @@ -832,7 +916,11 @@ The TargetedUserQuarantineTag specifies the quarantine policy that's used on mes - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -848,7 +936,7 @@ 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. @@ -856,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 diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/exchange/New-AntiPhishRule.md index feaed8486a..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ New-AntiPhishRule [-Name] -AntiPhishPolicy 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. > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Common policy settings](https://docs.microsoft.com/microsoft-365/security/office-365-security/set-up-anti-phishing-policies#common-policy-settings). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 +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[] @@ -247,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[] diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/exchange/New-App.md index d95593f82f..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,9 +123,9 @@ 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 @@ -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. @@ -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,6 +559,24 @@ 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. @@ -465,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: @@ -497,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. diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md index b9b71a9d86..669e94235e 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-appretentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancepolicy applicable: Security & Compliance title: New-AppRetentionCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-AppRetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,24 +43,27 @@ New-AppRetentionCompliancePolicy [-Name] -Applications [-Force] [-ModernGroupLocation ] [-ModernGroupLocationException ] + [-PolicyRBACScopes ] [-RestrictiveRetention ] [-WhatIf] [] ``` ## DESCRIPTION -\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Yammer chats, and Yammer 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. +\*-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. -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://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +\*-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,Yammer","Group:MicrosoftTeams,Yammer" -ExchangeLocation "Jennifer Petersen","Kitty Nakamura" +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 Yammer user messages of Jennifer Petersen and 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. @@ -103,13 +106,31 @@ Accept wildcard characters: False ``` ### -Applications -The Applications parameter specifies the applications to include in the policy and is relevant only for the following location parameters: +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: -- ExchangeLocation -- ModernGroupLocation -- AdaptiveScopeLocation + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` -This parameter uses the following syntax: `"LocationtType:App1,LocationType:App2,...LocationType:AppN` where LocationType is User or Group. For example, `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:Yammer"`. + **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[] @@ -306,6 +327,26 @@ 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: diff --git a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md index ee1ad10385..9cf40c975c 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancerule applicable: Security & Compliance title: New-AppRetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-AppRetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AppRetentionComplianceRule to create app retention compliance 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 @@ -49,7 +49,7 @@ New-AppRetentionComplianceRule -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://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 @@ -138,7 +138,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). ```yaml Type: PswsHashtable[] @@ -156,7 +156,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 @@ -183,7 +183,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"`. diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md index 350b479acb..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,12 +14,14 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +> [!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). + 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] @@ -29,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 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): @@ -121,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 more than one user mailbox. -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) @@ -130,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 @@ -190,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 diff --git a/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md deleted file mode 100644 index b5140a48ba..0000000000 --- a/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationrule -applicable: Security & Compliance -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 PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 - -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 - -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 - -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 - -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-AuthRedirect.md b/exchange/exchange-ps/exchange/New-AuthRedirect.md index 940e903e43..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 diff --git a/exchange/exchange-ps/exchange/New-AuthServer.md b/exchange/exchange-ps/exchange/New-AuthServer.md index 145bcb4237..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. diff --git a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md index f44d5707db..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,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 @@ -295,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 @@ -532,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. diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md index b4b5f410cf..41c5654713 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy applicable: Security & Compliance title: New-AutoSensitivityLabelPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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. Create auto-labeling policy rules using the New-AutoSensitivityLabelRule cmdlet and assoicate them with the policy to complete the policy creation. +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,6 +24,10 @@ 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 ] @@ -31,20 +35,29 @@ New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel [-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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 +66,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 auto-labeling 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 @@ -124,6 +137,76 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExchangeLocation 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). @@ -282,6 +365,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mode The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: @@ -304,8 +403,40 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business 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. +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"`. @@ -323,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"`. @@ -340,6 +471,44 @@ 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: @@ -361,8 +530,26 @@ 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 -{{ Fill PolicyTemplateInfo Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable @@ -393,10 +580,42 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online 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. +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 Online sites can't be added to a 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 sites can't be added to a policy until they have been indexed. ```yaml Type: MultiValuedProperty @@ -412,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"`. @@ -429,6 +648,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md index bc9b11c9ce..43a5384ec8 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule applicable: Security & Compliance title: New-AutoSensitivityLabelRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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 @@ -30,16 +30,24 @@ New-AutoSensitivityLabelRule [-Name] -Policy -Workl [-Confirm] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] + [-ContentPropertyContainsWords ] [-Disabled ] + [-DocumentCreatedBy ] [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentContainsSensitiveInformation ] [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentCreatedBy ] [-ExceptIfDocumentIsPasswordProtected ] [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] @@ -68,13 +76,14 @@ New-AutoSensitivityLabelRule [-Name] -Policy -Workl [-SenderIPRanges ] [-SentTo ] [-SentToMemberOf ] + [-SourceType ] [-SubjectMatchesPatterns ] [-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://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 @@ -168,7 +177,7 @@ The AnyOfRecipientAddressContainsWords parameter specifies a condition for the a - 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 auto-labeling policies that are scoped only to Exchange. @@ -245,6 +254,10 @@ 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) @@ -274,6 +287,24 @@ 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 +``` + ### -Disabled The Disabled parameter specifies whether the auto-labeling policy rule is enabled or disabled. Valid values are: @@ -293,8 +324,24 @@ 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 +``` + ### -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. @@ -331,6 +378,56 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfAccessScope The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy 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: @@ -359,7 +456,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 auto-labeling policies that are scoped only to Exchange. @@ -430,8 +527,42 @@ 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 +Default value: None +Accept pipeline input: False +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. @@ -468,6 +599,56 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfFrom The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: @@ -591,7 +772,7 @@ 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 @@ -893,7 +1074,7 @@ 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 @@ -1036,6 +1217,22 @@ 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"`. diff --git a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md index 0a41af17e5..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 diff --git a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md index e341668ae6..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,60 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -93,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. diff --git a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md index 0e2eb8fed2..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 diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md index 72bb3ef42b..87605314fc 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-caseholdpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdpolicy applicable: Security & Compliance title: New-CaseHoldPolicy schema: 2.0.0 @@ -12,13 +12,16 @@ ms.reviewer: # New-CaseHoldPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,19 +48,14 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 @@ -66,14 +64,19 @@ Aliases: 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 @@ -82,7 +85,7 @@ Aliases: Applicable: Security & Compliance Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -152,7 +155,7 @@ To specify a mailbox or distribution group, you can use the following values: - Name - SMTP address. To specify an inactive mailbox, precede the address with a period (.). -- Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) +- 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"`. @@ -206,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"`. diff --git a/exchange/exchange-ps/exchange/New-CaseHoldRule.md b/exchange/exchange-ps/exchange/New-CaseHoldRule.md index 9a9300f01e..c169c5dfff 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-caseholdrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdrule applicable: Security & Compliance title: New-CaseHoldRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -127,7 +127,7 @@ 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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 diff --git a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md index bea363cf16..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 @@ -18,7 +18,7 @@ Use the New-ClassificationRuleCollection cmdlet to import new classification rul 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,7 +31,7 @@ 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 @@ -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) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessArray.md b/exchange/exchange-ps/exchange/New-ClientAccessArray.md index 2cf8c98d2e..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. diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index cb3962f484..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 +> [!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 @@ -58,7 +61,7 @@ Protocols that support authentication type filters: - POP3: BasicAuthentication and OAuthAuthentication. - RemotePowerShell: BasicAuthentication and NonBasicAuthentication. -Protcols that don't support authentication type filters: +Protocols that don't support authentication type filters: - ExchangeWebServices - OfflineAddressBook @@ -67,7 +70,7 @@ Protcols that don't support authentication type filters: - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,33 +90,33 @@ 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 @@ -158,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 @@ -230,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) @@ -316,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 @@ -500,7 +505,7 @@ Accept wildcard characters: True ### -UserRecipientFilter 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 based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. +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 use the following properties with this parameter: @@ -517,9 +522,9 @@ You can use the following properties with this parameter: 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://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- 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. +- 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: @@ -531,7 +536,7 @@ You can chain multiple search criteria together using the logical operators `-an - `"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://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceCase.md b/exchange/exchange-ps/exchange/New-ComplianceCase.md index 3731d7d02d..6366bff3d0 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/New-ComplianceCase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancecase +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancecase applicable: Security & Compliance title: New-ComplianceCase schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -79,7 +79,7 @@ The CaseType parameter specifies the type of compliance case that you want to cr - 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 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 an risk alert. +- 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. diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md index eed5398fe5..f1f5f46411 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEvent +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentionevent applicable: Security & Compliance title: New-ComplianceRetentionEvent schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceRetentionEvent ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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. @@ -144,7 +144,7 @@ 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 @@ -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. @@ -194,7 +194,7 @@ 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 @@ -226,7 +226,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md index ecd479284d..f8097fbf29 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype applicable: Security & Compliance title: New-ComplianceRetentionEventType schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearch.md b/exchange/exchange-ps/exchange/New-ComplianceSearch.md index 287300c3c5..bb3b8def59 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancesearch +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -127,7 +127,7 @@ Accept wildcard characters: False ### -Case This parameter is available only in the cloud-based service. -The Case parameter specifies the name of a eDiscovery Standard 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 eDiscovery Premium cases. @@ -168,7 +168,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 @@ -322,7 +322,7 @@ 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 @@ -394,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"`. diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md index e5c080c99f..e2b6541d63 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancesearchaction +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -129,11 +131,13 @@ This example deletes the search results returned by a content search named Remov ### Example 4 ```powershell -New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst +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. +**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 ### -SearchName @@ -196,6 +200,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) @@ -210,6 +216,8 @@ Accept wildcard characters: False ``` ### -EnableDedupe +This parameter is available only in the cloud-based service. + This parameter is reserved for internal Microsoft use. ```yaml @@ -226,6 +234,9 @@ Accept wildcard characters: False ``` ### -ExchangeArchiveFormat + +**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. @@ -237,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. @@ -255,6 +266,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). + 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. @@ -277,6 +290,8 @@ 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 @@ -349,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: @@ -386,6 +403,8 @@ Accept wildcard characters: False ``` ### -NotifyEmail +**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. @@ -406,6 +425,8 @@ Accept wildcard characters: False ``` ### -NotifyEmailCC +**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. @@ -444,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. @@ -467,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. @@ -518,6 +544,8 @@ Accept wildcard characters: False ``` ### -Report +**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. @@ -536,6 +564,8 @@ 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 @@ -570,14 +600,14 @@ Accept wildcard characters: False ### -Scenario 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 Purview eDiscovery Premium. -- 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: +- 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 @@ -593,14 +623,14 @@ 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 @@ -635,6 +665,8 @@ Accept wildcard characters: False ``` ### -SharePointArchiveFormat +**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. @@ -643,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. @@ -661,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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md index 9be941ca8b..cf258e62c7 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter +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 @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. 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 @@ -33,7 +33,7 @@ New-ComplianceSecurityFilter -Action -Filte ## DESCRIPTION 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 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 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 ``` @@ -206,13 +172,13 @@ 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 -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://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions#searchable-email-properties). -- 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 filter that prevents them from mailboxes (see Example 9). Similarly, to allow an Exchange admin to only search mailboxes, you have to 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 diff --git a/exchange/exchange-ps/exchange/New-ComplianceTag.md b/exchange/exchange-ps/exchange/New-ComplianceTag.md index c308f1beb0..9de8c0fca4 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/New-ComplianceTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancetag +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancetag applicable: Security & Compliance title: New-ComplianceTag schema: 2.0.0 @@ -12,22 +12,27 @@ ms.reviewer: # New-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 ] @@ -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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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". @@ -89,6 +237,22 @@ 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 +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. @@ -173,13 +337,18 @@ 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. +### -FlowId +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. -You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. +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: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -191,14 +360,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsRecordLabel -The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -- $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. +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -210,19 +378,14 @@ 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]},]}'` +### -IsRecordLabel +The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: -This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers. +- $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 @@ -234,11 +397,11 @@ 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 ("). +### -IsRecordUnlockedAsDefault +{{ Fill IsRecordUnlockedAsDefault Description }} ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -250,28 +413,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Regulatory -{{ Fill Regulatory Description }} +### -MultiStageReviewProperty +The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +For example: -### -RetentionAction -The RetentionAction parameter specifies the action for the label. Valid values are: +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'` -- Delete -- Keep -- KeepAndDelete +This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers. ```yaml Type: String @@ -286,14 +437,11 @@ 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 @@ -305,16 +453,11 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-CustomNudge.md b/exchange/exchange-ps/exchange/New-CustomNudge.md deleted file mode 100644 index c2f66b5778..0000000000 --- a/exchange/exchange-ps/exchange/New-CustomNudge.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/new-customnudge -applicable: Exchange Online -title: New-CustomNudge -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# New-CustomNudge - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the New-CustomNudge cmdlet to create Custom Nudges that are displayed in user Briefing email 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). - -## SYNTAX - -``` -New-CustomNudge -Name -From -Title - [-Content ] - [-ResultSize ] - [] -``` - -## DESCRIPTION -Custom Nudges that are assigned to users appear their Briefing email messages. Users can mark these Custom Nudges as complete after they finish the task. - -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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -New-CustomNudge -Name perfReviewNudge -From "Microsoft HR" -Title "Please complete your performance reviews" -Content "They are very important to help your colleagues grow professionally." -``` - -This example creates a new Custom Nudge that can later be assigned to specific users to show in their Briefing email. - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for the Custom Nudge. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). - -This value is not shown to users. - -```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 -``` - -### -From -The From parameter specifies the creator of the Custom Nudge. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -Typically, this value is the name of the company or department that's responsible for the Custom Nudge. - -```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 -``` - -### -Title -The Title parameter specifies the bold title of the Custom Nudge that's displayed in the Briefing email. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```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 -``` - -### -Content -The Content parameter specifies the text that appears below the Custom Nudge title in the Briefing email. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). - -To include hyperlinks, use the markdown format. For example, `[Contoso](https://www.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 -``` - -### -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/New-CustomNudgeAssignment.md b/exchange/exchange-ps/exchange/New-CustomNudgeAssignment.md deleted file mode 100644 index 86a1a74f99..0000000000 --- a/exchange/exchange-ps/exchange/New-CustomNudgeAssignment.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/new-customnudgeassignment -applicable: Exchange Online -title: New-CustomNudgeAssignment -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# New-CustomNudgeAssignment - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the New-CustomNudgeAssignment cmdlet to assign Custom Nudges to users. Custom Nudges are shown in the Briefing 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). - -## SYNTAX - -``` -New-CustomNudgeAssignment -AssigneeId -NudgeName - [-EndTime ] - [-ResultSize ] - [-StartTime ] - [] -``` - -## 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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -New-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId roy@contoso.onmicrosoft.com -StartTime 2/2/2022 -EndTime 2/10/2022 -``` - -This example assigns the Custom Nudge named perfReviewNudge to the user roy@contoso.onmicrosoft.com. If the Custom Nudge feature is enabled in the organization, and the current time is between the StartTime and EndTime values, the user will see the perfReviewNudge Custom Nudge in their next Briefing email message. - -## PARAMETERS - -### -AssigneeId -The AssigneeId parameter specifies the email address of the user that you want to assign the Custom Nudge to. - -Together, this parameter and the NudgeName parameter create the unique Custom Nudge assignment. - -```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 -``` - -### -NudgeName -The NudgeName parameter specifies the name of the Custom Nudge that you want to assign to the user. If the value contains spaces, enclose the value in quotation marks ("). - -Together, this parameter and the AssigneeId parameter create the unique Custom Nudge assignment. - -```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 -``` - -### -EndTime -The EndTime parameter specifies the date when the Custom Nudge is no longer shown to the user. - -```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 -``` - -### -StartTime -The StartTime parameter specifies the date when the Custom Nudge is first shown to the user. - -```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-DataClassification.md b/exchange/exchange-ps/exchange/New-DataClassification.md index a5d40e0c12..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 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS 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 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 ` 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 diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md index 0935ff7588..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 diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md index e11e036dac..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 diff --git a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md index 6499677200..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 diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md index 79ce6ad53b..b8386092bb 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy applicable: Security & Compliance title: New-DeviceConditionalAccessPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md index 5fbe2e832a..102c007035 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule applicable: Security & Compliance title: New-DeviceConditionalAccessRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 @@ -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: @@ -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: @@ -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: diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md index fce5baa160..67e19df788 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy applicable: Security & Compliance title: New-DeviceConfigurationPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md index d1cdd6c826..e4505ceb8f 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule applicable: Security & Compliance title: New-DeviceConfigurationRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConfigurationRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 @@ -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: @@ -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: @@ -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: diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md index 897942ef38..13317afc2d 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-devicetenantpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantpolicy applicable: Security & Compliance title: New-DeviceTenantPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md index c100d58c9d..214a1d7524 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-devicetenantrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantrule applicable: Security & Compliance title: New-DeviceTenantRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceTenantRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/exchange/New-DistributionGroup.md index 28734e401d..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 @@ -59,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 @@ -105,7 +107,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -165,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 @@ -245,7 +250,7 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -295,10 +300,12 @@ Accept wildcard characters: False ### -HiddenGroupMembershipEnabled This parameter is available only in the cloud-based service. -The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from members of the group and users who aren't members of the group. You don't need to specify a value with this switch. +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 Parameter Sets: (All) @@ -339,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 @@ -426,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) diff --git a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md b/exchange/exchange-ps/exchange/New-DkimSigningConfig.md index 00daf3b707..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 ] + [-TeamsAdaptiveScopes ] + [-TeamsAdaptiveScopesException ] [-TeamsLocation ] [-TeamsLocationException ] [-ThirdPartyAppDlpLocation ] [-ThirdPartyAppDlpLocationException ] + [-ValidatePolicy] [-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://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,23 +79,77 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 ### -Name @@ -133,14 +203,62 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndpointDlpLocation -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. 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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -156,13 +274,33 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocationException -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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: `"","",...""`. -For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 + +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 @@ -178,9 +316,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy -The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive for Business user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com). +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 for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +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: `"","",...""`. @@ -200,9 +338,9 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf -The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive for Business sites of group members are excluded from the policy). You identify the groups by 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 for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +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: `"","",...""`. @@ -223,6 +361,38 @@ 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 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). @@ -250,7 +420,7 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf -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. +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: `"","",...""`. @@ -274,7 +444,7 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException -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. +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: `"","",...""`. @@ -315,13 +485,66 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mode The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: - 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 @@ -336,8 +559,40 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OneDriveLocation -The OneDriveLocation parameter specifies whether to include OneDrive for Business sites in the policy. A valid value for this parameter is All, which is also the default value. +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: @@ -349,11 +604,11 @@ You can use this parameter in the following procedures: - 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 for Business sites. +- If you use `-OneDriveLocation $null`, the policy does not apply to OneDrive sites. 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 365 Defender portal, you can't identify sites by URL; you specify sites only by users or groups. +**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 @@ -383,9 +638,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive for Business user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com). +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 for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +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: `"","",...""`. @@ -405,9 +660,9 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf -The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive for Business sites of group members are included in the policy). You identify the groups by 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 for Business sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). +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: `"","",...""`. @@ -433,7 +688,7 @@ The OnPremisesScannerDlpLocation parameter specifies the on-premises file shares 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://docs.microsoft.com/microsoft-365/compliance/dlp-on-premises-scanner-learn). +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 @@ -453,7 +708,25 @@ The OnPremisesScannerDlpLocationException parameter specifies the on-premises fi 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://docs.microsoft.com/microsoft-365/compliance/dlp-on-premises-scanner-learn). +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 + +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 @@ -471,7 +744,7 @@ 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://docs.microsoft.com/microsoft-365/compliance/what-the-dlp-policy-templates-include). +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 @@ -560,10 +833,42 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include in the DLP police. 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 Online sites to the policy until they have been indexed. +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: `"","",...""`. @@ -581,9 +886,9 @@ 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't add SharePoint Online sites to the policy until they have been indexed. +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: `"","",...""`. @@ -600,6 +905,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsAdaptiveScopes +{{ Fill TeamsAdaptiveScopes 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 +``` + +### -TeamsAdaptiveScopesException +{{ Fill TeamsAdaptiveScopesException 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 +``` + ### -TeamsLocation 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. @@ -637,13 +974,13 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpLocation -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/dlp-use-policies-non-microsoft-cloud-apps). +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 @@ -659,13 +996,13 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpLocationException -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/dlp-use-policies-non-microsoft-cloud-apps). +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 @@ -680,6 +1017,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 7f29468b76..177d38fa19 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpcompliancerule applicable: Security & Compliance title: New-DlpComplianceRule schema: 2.0.0 @@ -12,46 +12,54 @@ ms.reviewer: # New-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 ] [-DocumentCreatedBy ] [-DocumentCreatedByMemberOf ] - [-DocumentIsPasswordProtected + [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] @@ -68,17 +76,17 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfDocumentMatchesPatterns ] [-ExceptIfDocumentNameMatchesPatterns ] [-ExceptIfDocumentNameMatchesWords ] - [-ExceptIfDocumentSizeOver ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] - [-ExceptIfFromScope ] + [-ExceptIfFromScope ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfMessageSizeOver ] - [-ExceptIfMessageTypeMatches ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientADAttributeContainsWords ] [-ExceptIfRecipientADAttributeMatchesPatterns ] @@ -94,45 +102,58 @@ 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 ] + [-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 ] @@ -141,21 +162,25 @@ New-DlpComplianceRule [-Name] -Policy [-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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -164,7 +189,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 @@ -173,7 +198,7 @@ $contains_complex_types = @{ groups = @( @{ operator = "Or" - name = "PII Identifiers" + name = "PII Identifiers" sensitivetypes = @( @{ name = "Drug Enforcement Agency (DEA) Number" @@ -186,7 +211,7 @@ $contains_complex_types = @{ } @{ operator = "Or" - name = "Medical Terms" + name = "Medical Terms" sensitivetypes = @( @{ name = "International Classification of Diseases (ICD-9-CM)" @@ -211,7 +236,92 @@ $contains_complex_types = @{ New-DLPComplianceRule -Name "Contoso Medical Information" -Policy "Contoso Medical Checks" -ContentContainsSensitiveInformation $contains_complex_types ``` -This example create a new DLP compliance rule named "Contoso Medical Information" that is assigned to the "Contoso Medical Checks" policy. The rule uses advanced syntax to search for the specified content. +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 @@ -232,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) @@ -260,7 +370,7 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on - None: The condition isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -276,7 +386,7 @@ 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 @@ -309,6 +419,26 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AlertProperties {{ Fill AlertProperties Description }} @@ -332,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. @@ -369,6 +499,24 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplyHtmlDisclaimer The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. @@ -391,6 +539,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockAccess The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: @@ -413,12 +577,12 @@ 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 @@ -488,7 +652,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"})`. 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). For an example of advanced syntax, see Example 2 in this topic. @@ -506,7 +670,7 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -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. +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 @@ -537,8 +701,34 @@ 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 -{{ Fill ContentIsShared Description }} +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 @@ -611,7 +801,9 @@ Accept wildcard characters: False ``` ### -DocumentCreatedBy -{{ Fill DocumentCreatedBy Description }} +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. + +This parameter applies to Sharepoint and Onedrive workloads. ```yaml Type: MultiValuedProperty @@ -627,7 +819,9 @@ Accept wildcard characters: False ``` ### -DocumentCreatedByMemberOf -{{ Fill DocumentCreatedByMemberOf Description }} +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[] @@ -643,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. @@ -756,7 +950,7 @@ 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 @@ -767,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 ("). @@ -786,14 +996,30 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndpointDlpRestrictions -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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. +The `` value is one of the supported values. -The value of `` is Audit, Block, Ignore, or Warn. +The available values for `` are: Audit, Block, Ignore, or Warn. Example values: @@ -809,7 +1035,7 @@ 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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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[] @@ -824,6 +1050,53 @@ 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 +Default value: None +Accept pipeline input: False +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: @@ -832,7 +1105,7 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP - None: The exception isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -851,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. @@ -913,7 +1186,7 @@ The ExceptIfContentContainsSensitiveInformation parameter specifies an exception 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[] @@ -929,7 +1202,7 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords -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. +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 @@ -961,7 +1234,12 @@ Accept wildcard characters: False ``` ### -ExceptIfContentIsShared -{{ Fill ExceptIfContentIsShared Description }} +The ContentIsNotLabeled parameter specifies an exception 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 @@ -1015,7 +1293,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedBy -{{ Fill ExceptIfDocumentCreatedBy Description }} +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. + +This parameter applies to Sharepoint and Onedrive workloads. ```yaml Type: MultiValuedProperty @@ -1031,7 +1311,9 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentCreatedByMemberOf -{{ Fill ExceptIfDocumentCreatedByMemberOf Description }} +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. + +This parameter applies to Sharepoint and Onedrive workloads. ```yaml Type: RecipientIdParameter[] @@ -1047,7 +1329,7 @@ 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: +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. @@ -1160,7 +1442,7 @@ 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 @@ -1255,13 +1537,13 @@ 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 @@ -1348,7 +1630,7 @@ 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 @@ -1375,7 +1657,7 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha 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 @@ -1411,33 +1693,33 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f - 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. @@ -1461,33 +1743,33 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception - 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. @@ -1507,7 +1789,7 @@ 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 @@ -1527,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. @@ -1577,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. @@ -1781,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. @@ -1808,7 +2090,7 @@ 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 @@ -1824,7 +2106,7 @@ 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 @@ -1919,13 +2201,13 @@ 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 @@ -2044,7 +2326,7 @@ 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 @@ -2072,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 @@ -2080,7 +2362,7 @@ 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[] @@ -2095,6 +2377,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. @@ -2111,7 +2409,7 @@ 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 @@ -2150,8 +2448,24 @@ 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")}`. +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. @@ -2202,7 +2516,7 @@ The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule t You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: NonBifurcatingAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2218,6 +2532,7 @@ Accept wildcard characters: False 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. @@ -2236,6 +2551,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. @@ -2255,10 +2586,10 @@ 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. -This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): +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. @@ -2275,12 +2606,44 @@ 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 Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -2295,6 +2658,38 @@ 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 + +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. @@ -2312,9 +2707,9 @@ 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`. +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://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +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:คำแนะนำนโยบายในไทย"`. @@ -2331,6 +2726,41 @@ 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: @@ -2354,6 +2784,27 @@ 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 }} @@ -2371,7 +2822,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 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. @@ -2402,7 +2853,7 @@ Valid values and the default value for this parameter depend on the number of ex 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: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2459,33 +2910,33 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL - 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. @@ -2509,35 +2960,35 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the - 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. @@ -2554,8 +3005,26 @@ 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 @@ -2650,6 +3119,38 @@ 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 +Default value: None +Accept pipeline input: False +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: @@ -2658,7 +3159,7 @@ 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 @@ -2675,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. @@ -2725,35 +3226,35 @@ 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. @@ -2777,7 +3278,7 @@ The SenderAddressLocation parameter specifies where to look for sender addresses - 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: +Note that message envelope searching is available only for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords @@ -2817,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. @@ -2894,6 +3395,28 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopPolicyProcessing The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: @@ -2995,8 +3518,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThirdPartyAppDlpRestrictions +{{ Fill ThirdPartyAppDlpRestrictions 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 +``` + +### -TriggerPowerAutomateFlow +{{ Fill TriggerPowerAutomateFlow 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 +``` + ### -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. @@ -3013,6 +3568,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. @@ -3039,7 +3610,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md index a52f364b9f..27c440830a 100644 --- a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpedmschema +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpedmschema applicable: Security & Compliance title: New-DlpEdmSchema schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,9 +28,9 @@ 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/New-DlpFingerprint.md index d67dfc9ad2..cbd457cd29 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpfingerprint +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint applicable: Security & Compliance title: New-DlpFingerprint schema: 2.0.0 @@ -12,18 +12,19 @@ ms.reviewer: # New-DlpFingerprint ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 - [-Threshold ] + [-IsExact ] [-Confirm] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -31,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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Patent Template.docx)' + $Patent_Fingerprint = New-DlpFingerprint -FileData $Patent_Template -Description "Contoso Patent Template" ``` @@ -54,7 +56,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -98,16 +100,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Threshold -The Threshold parameter specifies the confidence threshold to use for matches. Valid values are 0 to 100: +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance -- The value 0 matches all items, resulting in many false positives. -- The value 100 demands a near-perfect match, but might also result in more false negatives. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The default value is 50. +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} ```yaml -Type: UInt32 +Type: PswsHashtable Parameter Sets: (All) Aliases: Applicable: Security & Compliance diff --git a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md index 67cd062669..10ac021e60 100644 --- a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary applicable: Security & Compliance title: New-DlpKeywordDictionary schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 New-DlpKeywordDictionary -Name [-Confirm] [-Description ] + [-DoNotPersistKeywords] [-FileData ] [-Organization ] [-WhatIf] @@ -33,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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 ``` @@ -49,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")} + New-DlpKeywordDictionary -Name "Inappropriate Language" -Description "Unprofessional and inappropriate terminology" -FileData $EncodedKeywords ``` @@ -108,6 +113,22 @@ 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 +Default value: None +Accept pipeline input: False +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. diff --git a/exchange/exchange-ps/exchange/New-DlpPolicy.md b/exchange/exchange-ps/exchange/New-DlpPolicy.md index c3c72c030c..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 @@ -103,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 diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md index 07d5c77bee..961c0d2e48 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype applicable: Security & Compliance title: New-DlpSensitiveInformationType schema: 2.0.0 @@ -12,18 +12,23 @@ ms.reviewer: # New-DlpSensitiveInformationType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Employee Template.docx') + $Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template" + $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,8 +57,10 @@ 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 @@ -57,15 +68,15 @@ Parameter Sets: (All) Aliases: 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 @@ -80,10 +91,8 @@ 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 @@ -91,8 +100,24 @@ Parameter Sets: (All) Aliases: 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 @@ -117,10 +142,26 @@ 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 +Default value: None +Accept pipeline input: False +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. @@ -137,6 +178,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md index a836641210..ff65bcc045 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-DlpSensitiveInformationTypeRulePackage +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance title: New-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-DlpSensitiveInformationTypeRulePackage ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,13 +31,12 @@ 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 ([System.IO.File]::ReadAllBytes('C:\My Documents\External Sensitive Info Type Rule Collection.xml')) ``` @@ -125,4 +124,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 bd2a9b4c63..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). +- 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). @@ -185,7 +185,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -247,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 @@ -267,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 @@ -287,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 @@ -307,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 @@ -327,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 @@ -347,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 @@ -367,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 @@ -387,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 @@ -407,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 @@ -427,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 @@ -447,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 @@ -467,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 @@ -487,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 @@ -507,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 @@ -527,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 @@ -547,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 @@ -567,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 @@ -587,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 diff --git a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md deleted file mode 100644 index 35fe53dd64..0000000000 --- a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md +++ /dev/null @@ -1,243 +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 maximum length 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 Azure AD 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 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 1c215fc6d4..0000000000 --- a/exchange/exchange-ps/exchange/New-EOPMailUser.md +++ /dev/null @@ -1,226 +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 (Get-Credential).password -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 prompting you to enter the password. - -## 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. - -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: 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 maximum length 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 Azure AD 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 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 index aa5b3f4502..0f0e180485 100644 --- a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-eopprotectionpolicyrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection title: New-EOPProtectionPolicyRule schema: 2.0.0 @@ -16,9 +16,9 @@ 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 365 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. +**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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 +38,12 @@ New-EOPProtectionPolicyRule [-Name] [-Priority ] -AntiPhishPolic ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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 or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Profiles in preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#profiles-in-preset-security-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 ### -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 365 Defender portal, the name of the anti-phishing policy will be one of the following values: +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`. @@ -100,7 +100,7 @@ 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 365 Defender portal, the name of the anti-spam policy will be one of the following values: +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`. @@ -123,7 +123,7 @@ 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 365 Defender portal, the name of the anti-malware policy will be one of the following values: +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`. @@ -203,7 +203,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[] @@ -291,7 +291,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[] diff --git a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md index 6ef61a16c9..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 diff --git a/exchange/exchange-ps/exchange/New-EdgeSubscription.md b/exchange/exchange-ps/exchange/New-EdgeSubscription.md index 87fe59801a..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 -$Temp = [System.IO.File]::ReadAllBytes('C:\EdgeServerSubscription.xml') +$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 ([System.IO.File]::ReadAllBytes('C:\EdgeServerSubscription.xml')) -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. diff --git a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md index a6392f8e51..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 diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md index 00a8b4d0fe..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. @@ -220,7 +220,7 @@ Accept wildcard characters: False ### -EnabledPrimarySMTPAddressTemplate 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). +- 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). +- 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. diff --git a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md index 81c70c0aaa..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,7 +16,7 @@ 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 @@ -67,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,7 +84,7 @@ 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 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. @@ -95,12 +95,12 @@ If you don't want this certificate to replace the existing self-signed certifica Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate -PrivateKeyExportable $true ``` -This example shows how to renew a self-signed certificate with a specific thumbprint value. You can find the thumbprint value in one of two ways: +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. -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). +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 @@ -123,6 +123,7 @@ If the CA requires the certificate request in a file that's encoded by DER, use ### Example 4 ```powershell $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)) ``` @@ -133,6 +134,7 @@ This method is required in Exchange 2016 and Exchange 2019 because the RequestFi ### 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) ``` @@ -158,6 +160,7 @@ After you create the certificate renewal request, you send the output to the CA. ### Example 7 ```powershell $txtrequest = Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest + [System.IO.File]::WriteAllBytes('C:\Cert Requests\fabrikam_renewal.req', [System.Text.Encoding]::Unicode.GetBytes($txtrequest)) ``` @@ -168,6 +171,7 @@ This method is required in Exchange 2016 and Exchange 2019 because the RequestFi ### Example 8 ```powershell $binrequest = Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest + [System.IO.File]::WriteAllBytes('C:\Cert Requests\fabrikam_renewal.pfx', $binrequest.FileData) ``` @@ -235,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. @@ -514,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. diff --git a/exchange/exchange-ps/exchange/New-ExchangeSettings.md b/exchange/exchange-ps/exchange/New-ExchangeSettings.md index cd75de7175..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 diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md similarity index 62% rename from exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md rename to exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md index 5bd0c6bf7e..cc46098b0a 100644 --- a/exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md +++ b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md @@ -1,65 +1,51 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-phishsimoverriderule -applicable: Security & Compliance -title: New-PhishSimOverrideRule +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-PhishSimOverrideRule +# New-ExoPhishSimOverrideRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -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). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-PhishSimOverrideRule [-Name] -Policy -SenderIpRanges +New-ExoPhishSimOverrideRule -Policy -SenderIpRanges [-Comment ] [-Confirm] - [-Domains ] - [-SenderDomainIs ] + [-DomainController ] + [-Domains ] + [-Name ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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-PhishSimOverrideRule -Name PhishSimOverrideRule -Policy PhishSimOverridePolicy -Domains fabrikam.com,wingtiptoys.com -SenderIpRanges 192.168.1.55 +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. +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 -### -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 - -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: @@ -70,9 +56,9 @@ The Policy parameter specifies the phishing simulation override policy that's as ```yaml Type: PolicyIdParameter -Parameter Sets: (All)) +Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: True Position: Named @@ -94,9 +80,9 @@ A phishing simulation entry requires at least one IP address in this parameter a ```yaml Type: MultiValuedProperty -Parameter Sets: (All) +Parameter Sets: Default Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: True Position: Named @@ -110,9 +96,9 @@ The Comment parameter specifies an optional comment. If you specify a value that ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Default Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -131,7 +117,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance +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 @@ -152,9 +154,9 @@ A phishing simulation requires at least one domain from this parameter and at le ```yaml Type: MultiValuedProperty -Parameter Sets: (All) +Parameter Sets: Default Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -163,14 +165,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderDomainIs -This parameter has been replaced by the Domains parameter. +### -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: MultiValuedProperty -Parameter Sets: (All) +Type: String +Parameter Sets: Default Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -180,13 +182,13 @@ Accept wildcard characters: False ``` ### -WhatIf -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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named 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 4230b628cb..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 @@ -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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md index 9a3b41b934..4d11d7b876 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertyauthority +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md index d9ddd90213..acdefd1244 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertycategor +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md index 598b73355e..80625e0af9 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertycitation +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md index 601c905a32..8d084f8c09 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertydepartment +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md index 2229f4a2f0..f32d9f3ac4 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertyreferenceid +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md index 7d676d5f82..ceff1b7f3e 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertysubcategory +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/New-Fingerprint.md b/exchange/exchange-ps/exchange/New-Fingerprint.md index 4a5f0702af..b2d1f80558 100644 --- a/exchange/exchange-ps/exchange/New-Fingerprint.md +++ b/exchange/exchange-ps/exchange/New-Fingerprint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fingerprint +online version: https://learn.microsoft.com/powershell/module/exchange/new-fingerprint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-Fingerprint schema: 2.0.0 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is functional only in on-premises Exchange. -**Note**: In Exchange Online, this cmdlet has been replaced by the [New-DlpFingerPrint](https://docs.microsoft.com/powershell/module/exchange/new-dlpfingerprint) cmdlet in Security & Compliance PowerShell. +**Note**: In Exchange Online, this cmdlet has been replaced by the [New-DlpFingerPrint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) cmdlet in Security & Compliance PowerShell. Use the New-Fingerprint cmdlet to create document fingerprints that are used with data classification rules. Because the results of New-Fingerprint are not stored outside of the data classification rule, you always run New-Fingerprint and New-DataClassification or Set-DataClassification 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 @@ -32,13 +32,14 @@ New-Fingerprint [[-FileData] ] -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 = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Patent Template.docx') + $Patent_Fingerprint = New-Fingerprint -FileData $Patent_Template -Description "Contoso Patent Template" ``` diff --git a/exchange/exchange-ps/exchange/New-ForeignConnector.md b/exchange/exchange-ps/exchange/New-ForeignConnector.md index d259e88796..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. diff --git a/exchange/exchange-ps/exchange/New-GlobalAddressList.md b/exchange/exchange-ps/exchange/New-GlobalAddressList.md index 327aa1af8b..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). +- 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 diff --git a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md index 8260c21113..68a8cdeb6a 100644 --- a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy applicable: Security & Compliance title: New-HoldCompliancePolicy schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # New-HoldCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 PowerShell, you need to be assigned 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 @@ -186,11 +186,11 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md index 322272fcda..9ebebdb7c5 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancerule applicable: Security & Compliance title: New-HoldComplianceRule schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # New-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -122,7 +122,7 @@ 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 @@ -140,7 +140,7 @@ 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 @@ -158,7 +158,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 7fe76e7281..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,6 +51,7 @@ New-HostedContentFilterPolicy [-Name] [-IncreaseScoreWithNumericIps ] [-IncreaseScoreWithRedirectToOtherPort ] [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] [-LanguageBlockList ] [-MarkAsSpamBulkMail ] [-MarkAsSpamEmbedTagsInHtml ] @@ -67,7 +68,7 @@ New-HostedContentFilterPolicy [-Name] [-ModifySubjectValue ] [-PhishQuarantineTag ] [-PhishSpamAction ] - [-PhishZapEnabled + [-PhishZapEnabled ] [-QuarantineRetentionPeriod ] [-RecommendedPolicyType ] [-RedirectToRecipients ] @@ -82,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 @@ -166,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"`. @@ -188,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"`. @@ -210,7 +211,7 @@ 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 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"`. @@ -232,7 +233,7 @@ 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 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"`. @@ -258,7 +259,11 @@ The BulkQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -279,9 +284,9 @@ The BulkSpamAction parameter specifies the action to take on messages that are m - 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 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 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. +- 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 @@ -300,7 +305,7 @@ Accept wildcard characters: False ### -BulkThreshold 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 @@ -335,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 @@ -356,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 @@ -413,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 @@ -429,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 @@ -445,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 @@ -463,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 @@ -481,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 @@ -503,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 @@ -521,7 +508,6 @@ 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. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - 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. @@ -545,7 +531,11 @@ The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -566,8 +556,8 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages - 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 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 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. +- 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 @@ -590,7 +580,11 @@ The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy th - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -606,12 +600,10 @@ 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. - 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 @@ -628,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 @@ -650,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 @@ -672,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 @@ -712,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 @@ -759,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. @@ -781,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. @@ -803,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. @@ -825,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. @@ -847,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. @@ -868,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. @@ -890,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. @@ -911,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. @@ -933,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. @@ -955,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. @@ -976,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. @@ -1027,7 +1010,11 @@ The PhishQuarantineTag parameter specifies the quarantine policy that's used on - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -1048,9 +1035,9 @@ The PhishSpamAction parameter specifies the action to take on messages that 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. +- 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: Move 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. +- 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 @@ -1114,7 +1101,7 @@ 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 @@ -1184,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 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 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. +- 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 @@ -1208,7 +1195,11 @@ The SpamQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -1245,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. @@ -1267,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. diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md index 3301f82ea1..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ New-HostedContentFilterRule [-Name] -HostedContentFilterPolicy [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Use the Microsoft 365 Defender portal to create anti-spam policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies#use-the-microsoft-365-defender-portal-to-create-anti-spam-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,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 @@ -147,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[] @@ -239,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[] diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md index 06e87fc0b5..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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,11 +111,11 @@ Accept wildcard characters: False ### -AutoForwardingMode The AutoForwardingMode specifies how the policy controls automatic email forwarding to external recipients. Valid values are: -- Automatic: This is the default value. This setting is now the same as Off. When this setting was originally introduced, this value was equivalent to On. Over time, thanks to the principles of [secure by default](https://docs.microsoft.com/microsoft-365/security/office-365-security/secure-by-default), this value was gradually changed to the equivalent of 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 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 @@ -169,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: @@ -190,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. @@ -210,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 @@ -226,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 @@ -242,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 @@ -258,7 +258,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md index a1204d5611..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/New-HybridConfiguration.md b/exchange/exchange-ps/exchange/New-HybridConfiguration.md index 24d9d39976..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 diff --git a/exchange/exchange-ps/exchange/New-InboundConnector.md b/exchange/exchange-ps/exchange/New-InboundConnector.md index e394a06a40..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,13 +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. -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**: 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` New-InboundConnector [-Name] -SenderDomains [-AssociatedAcceptedDomains ] + [-ClientHostNames ] [-CloudServicesMailEnabled ] [-Comment ] [-Confirm] @@ -49,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 @@ -89,7 +92,7 @@ Accept wildcard characters: False ``` ### -SenderDomains -The SenderDomains parameter specifies the source domains that the connector accepts messages for. 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). +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. @@ -124,8 +127,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClientHostNames +{{ Fill ClientHostNames 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 +``` + ### -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. @@ -208,7 +227,7 @@ Accept wildcard characters: False The ConnectorType parameter specifies the category for the source domains that the connector accepts messages for. Valid values are: - Partner: External partners or services. -- OnPremises: Your on-premises email 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 @@ -334,11 +353,13 @@ Accept wildcard characters: False ``` ### -RequireTls -The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by the connector. Valid values are: +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 Parameter Sets: (All) @@ -353,11 +374,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate -The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the connector. Valid values are: +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 Parameter Sets: (All) @@ -372,11 +395,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses -The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses. Valid values are: +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. +**Note**: This parameter applies only to Partner type connectors. + ```yaml Type: Boolean Parameter Sets: (All) @@ -407,7 +432,7 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses -The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the connector accepts messages from. 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. @@ -416,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) @@ -472,7 +499,9 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations -{{ Fill TrustedOrganizations Description }} +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 diff --git a/exchange/exchange-ps/exchange/New-InboxRule.md b/exchange/exchange-ps/exchange/New-InboxRule.md index 7f2150b0df..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 @@ -116,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. @@ -130,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 @@ -266,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. @@ -416,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. @@ -464,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 @@ -493,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. @@ -552,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. @@ -686,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. @@ -706,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. @@ -726,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. @@ -794,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. @@ -814,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 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 @@ -1062,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. @@ -1121,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. @@ -1387,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. @@ -1407,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. @@ -1427,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. @@ -1577,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. @@ -1597,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. diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md index d9661ccbb9..0e1826be8c 100644 --- a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy applicable: Security & Compliance title: New-InformationBarrierPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,7 @@ New-InformationBarrierPolicy [-Name] -AssignedSegment -Segment [-Comment ] [-Confirm] [-Force] + [-ModerationAllowed ] [-State ] [-WhatIf] [] @@ -37,6 +38,7 @@ New-InformationBarrierPolicy [-Name] -AssignedSegment -Segment [-Comment ] [-Confirm] [-Force] + [-ModerationAllowed ] [-WhatIf] [] ``` @@ -47,6 +49,7 @@ New-InformationBarrierPolicy [-Name] -AssignedSegment -Segment [-Comment ] [-Confirm] [-Force] + [-ModerationAllowed ] [-WhatIf] [] ``` @@ -54,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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -224,6 +227,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -State The State parameter specifies whether the information barrier policy is active or inactive. Valid values are: @@ -271,4 +290,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 9d8f13c3b2..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 diff --git a/exchange/exchange-ps/exchange/New-JournalRule.md b/exchange/exchange-ps/exchange/New-JournalRule.md index e435108bd7..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 diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index 76741d1bdb..ccfa3a9d5e 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label +online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label applicable: Security & Compliance title: New-Label schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 ] @@ -76,14 +79,31 @@ New-Label [-Name] -DisplayName -Tooltip [-SiteAndGroupProtectionBlockAccess ] [-SiteAndGroupProtectionEnabled ] [-SiteAndGroupProtectionLevel ] - [-SiteAndGroupProtectionPrivacy ] + [-SiteAndGroupProtectionPrivacy ] [-SiteExternalSharingControlType ] + [-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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -147,21 +167,29 @@ Accept wildcard characters: False ### -AdvancedSettings 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://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 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. -Many 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 and services that support built-in labeling. For a list of these and 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: -- **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://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-default-sharing-link). +- **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). -- **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://docs.microsoft.com/microsoft-365/compliance/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). -- **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://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-teams-groups-sites#configure-site-sharing-permissions-by-using-powershell-advanced-settings). +- **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). -- **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](/microsoft-365/compliance/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](/microsoft-365/compliance/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). +- **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 @@ -240,6 +268,8 @@ 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) @@ -276,6 +306,8 @@ 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) @@ -407,6 +439,8 @@ 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) @@ -438,6 +472,29 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplyWaterMarkingEnabled The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: @@ -512,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 @@ -618,13 +675,17 @@ 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 @@ -639,6 +700,45 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EncryptionAipTemplateScopes The EncryptionAipTemplateScopes parameter specifies that the label is still published and usable in the AIP classic client. An example value is `"['allcompany@labelaction.onmicrosoft.com','admin@labelaction.onmicrosoft.com']"`. @@ -844,7 +944,7 @@ 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 @@ -875,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. @@ -1176,7 +1276,7 @@ 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 @@ -1216,6 +1316,337 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -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: 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. + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index 31e38b9e0c..ce59ac07c5 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-labelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-labelpolicy applicable: Security & Compliance title: New-LabelPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-LabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -99,23 +100,35 @@ 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: `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://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: `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://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"}`. -- **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+), and also Outlook on Windows (version 2201+). Example: `Set-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: `New-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: `New-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 @@ -315,6 +328,24 @@ 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 +``` + ### -PublicFolderLocation This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md index 0657fd5c6e..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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,37 +57,37 @@ 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 @@ -99,7 +99,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. diff --git a/exchange/exchange-ps/exchange/New-MailMessage.md b/exchange/exchange-ps/exchange/New-MailMessage.md index 4cd1935953..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 diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/exchange/New-MailUser.md index 19870e84c4..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,14 +210,17 @@ 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 @@ -228,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,7 +340,7 @@ You can use the following methods as a value for this parameter: ```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 @@ -332,7 +375,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -510,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: @@ -545,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 @@ -687,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 @@ -699,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 diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/exchange/New-Mailbox.md index db2f4fcd8e..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 ] @@ -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 ``` @@ -791,7 +795,9 @@ This example creates an enabled user account in Active Directory and a room mail ### 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 @@ -1190,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 @@ -1287,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 @@ -1308,7 +1320,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -1651,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 @@ -1701,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 @@ -1877,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. @@ -1896,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. @@ -1990,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 @@ -2006,12 +2036,17 @@ 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. -To use this parameter, you need to be a member of one of the following role groups: +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). -- 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. +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. You can use the following methods as a value for this parameter: @@ -2019,6 +2054,8 @@ You can use the following methods as a value for this parameter: - 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 [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. + ```yaml Type: SecureString Parameter Sets: EnableRoomMailboxAccount diff --git a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md index 6d2407c5b6..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 diff --git a/exchange/exchange-ps/exchange/New-MailboxDatabase.md b/exchange/exchange-ps/exchange/New-MailboxDatabase.md index 4d3909801a..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 diff --git a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md index 73209f6ba0..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). +- 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 @@ -618,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. diff --git a/exchange/exchange-ps/exchange/New-MailboxFolder.md b/exchange/exchange-ps/exchange/New-MailboxFolder.md index cce7c9c089..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 diff --git a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md index 42c0c5ab39..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 @@ -603,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. diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md index 987e8fa966..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. diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index a071999332..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] @@ -88,6 +90,8 @@ New-MailboxRestoreRequest -SourceDatabase -SourceStoreMail [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -120,6 +124,8 @@ New-MailboxRestoreRequest -SourceStoreMailbox -TargetM [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -182,6 +188,8 @@ New-MailboxRestoreRequest -RemoteDatabaseGuid -RemoteHostName -Rem [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -217,13 +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-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,6 +249,17 @@ New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox "Tony Smit 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 @@ -502,7 +524,7 @@ 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://docs.microsoft.com/microsoft-365/compliance/restore-an-inactive-mailbox#restore-inactive-mailboxes). +**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 @@ -635,6 +657,53 @@ 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 functional only in on-premises Exchange. @@ -786,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. @@ -1006,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) diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/exchange/New-MailboxSearch.md index 32e965c329..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 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 @@ -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 @@ -234,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 @@ -352,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 @@ -387,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 @@ -399,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 @@ -502,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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. @@ -582,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 @@ -656,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 diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index 0bd2a4c041..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 @@ -55,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 @@ -66,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 @@ -93,9 +92,9 @@ 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 @@ -192,7 +191,7 @@ 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 DeleteAttachmentAndUseCustomAlert. +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. ```yaml Type: String @@ -208,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 @@ -229,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 @@ -250,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 @@ -273,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 @@ -296,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 @@ -317,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 @@ -338,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 @@ -375,10 +381,10 @@ 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 attachments are 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 attachments are 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. @@ -398,9 +404,9 @@ Accept wildcard characters: False ### -EnableExternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableExternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from external senders. Valid values are: +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. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. +- $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 @@ -419,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. + +You specify the file types using the FileTypes parameter. A default list of values is automatically provided, but you can customize it. -- $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 action for detected files using the FileTypeAction parameter. ```yaml Type: Boolean @@ -438,12 +448,10 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications -This parameter is available only in on-premises Exchange. - -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, 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 attachments are detected in messages from internal senders, don't send administrator notifications. This is the default value. +- $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. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -451,7 +459,7 @@ The EnableInternalSenderAdminNotifications parameter enables or disables sending Type: Boolean 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 @@ -463,9 +471,9 @@ Accept wildcard characters: False ### -EnableInternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableInternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from internal senders. Valid values are: +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 @@ -482,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 @@ -500,12 +510,12 @@ Accept wildcard characters: False ### -FileTypeAction This parameter is available only in the cloud-based service. -The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (common attachment blocking). Valid values are: +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 policy by the QuarantineTag parameter. -- Reject: This is the default action. 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. +- 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 EnableFileFilter parameter is set to the value $true. +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. ```yaml Type: FileTypeFilteringAction @@ -523,13 +533,13 @@ 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, apk, app, appx, arj, bat, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, jar, 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` +`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. @@ -549,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 @@ -569,13 +579,17 @@ Accept wildcard characters: False ### -QuarantineTag This parameter is available only in the cloud-based service. -The QuarantineTag 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: +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 based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -593,7 +607,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md index 362e35b849..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 @@ -39,9 +39,9 @@ New-MalwareFilterRule [-Name] -MalwareFilterPolicy [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Anti-malware policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/anti-malware-protection#anti-malware-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 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. - -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 @@ -164,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[] @@ -256,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[] diff --git a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md index 47eb82a600..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: diff --git a/exchange/exchange-ps/exchange/New-ManagedFolder.md b/exchange/exchange-ps/exchange/New-ManagedFolder.md index e832c1ab35..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. diff --git a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md index 93ccff6498..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). diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/exchange/New-ManagementRole.md index 85d195a148..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 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://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. -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 Parent parameter. diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index 60b9e5cda7..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,7 +16,7 @@ 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 @@ -27,6 +27,7 @@ New-ManagementRoleAssignment [[-Name] ] -Role -App ] + [-RecipientGroupScope ] [-WhatIf] [] ``` @@ -42,6 +43,7 @@ New-ManagementRoleAssignment [[-Name] ] -Computer [-ExclusiveRecipientWriteScope ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -60,6 +62,7 @@ New-ManagementRoleAssignment [[-Name] ] -Policy ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -79,6 +82,7 @@ New-ManagementRoleAssignment [[-Name] ] -Role -Securit [-ExclusiveRecipientWriteScope ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -98,6 +102,7 @@ New-ManagementRoleAssignment [[-Name] ] -Role -User ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -110,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 @@ -126,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" ``` @@ -189,9 +195,9 @@ 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 ServiceId GUID value from the output of the Get-ServicePrincipal cmdlet (for example, 6233fba6-0198-4277-892f-9275bf728bcc). +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 Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals). +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. @@ -199,7 +205,7 @@ You can't use this parameter with the SecurityGroup, Policy, or User cmdlets. Type: ServicePrincipalIdParameter Parameter Sets: App Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -291,7 +297,12 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the name or alias of the user to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). +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`. You can't use this parameter with the App, SecurityGroup, Computer, or Policy parameters. @@ -372,13 +383,13 @@ The CustomResourceScope parameter specifies the custom management scope to assoc 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 Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals). +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 +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -476,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 @@ -493,6 +506,24 @@ 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 ("). @@ -530,11 +561,11 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/exchange/New-ManagementScope.md index e9248e5d8c..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 @@ -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). +- 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). +- 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). +- 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. @@ -405,5 +406,6 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 87ece62a7a..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 @@ -184,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 diff --git a/exchange/exchange-ps/exchange/New-MessageClassification.md b/exchange/exchange-ps/exchange/New-MessageClassification.md index 9d343a609d..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 @@ -111,7 +111,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-MigrationBatch.md b/exchange/exchange-ps/exchange/New-MigrationBatch.md index 4e4309d6ac..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,7 +681,7 @@ 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). 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`). @@ -408,7 +689,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```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 @@ -711,7 +966,7 @@ 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: @@ -753,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'"` @@ -779,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 @@ -794,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 @@ -837,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 @@ -902,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 @@ -931,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. @@ -965,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 @@ -981,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. @@ -990,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 @@ -1006,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 @@ -1021,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. @@ -1028,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 @@ -1064,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 @@ -1120,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 @@ -1169,6 +1494,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Restore +This parameter is available only in the cloud-based service. + +{{ Fill Restore 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 +``` + +### -SimplifiedSwitchOver +This parameter is available only in the cloud-based service. + +{{ Fill SimplifiedSwitchOver 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 +``` + ### -SkipCalendar This parameter is available only in the cloud-based service. @@ -1176,7 +1537,7 @@ The SkipCalendar switch specifies that you want to skip calendar migration durin ```yaml Type: SwitchParameter -Parameter Sets: Onboarding +Parameter Sets: Onboarding, ManagedGmailTeams Aliases: Applicable: Exchange Online @@ -1194,7 +1555,43 @@ The SkipContacts switch specifies that you want to skip contact migration during ```yaml Type: SwitchParameter -Parameter Sets: Onboarding +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 @@ -1228,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 @@ -1257,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. @@ -1303,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 @@ -1324,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 @@ -1356,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: @@ -1419,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 @@ -1567,6 +1982,24 @@ 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). diff --git a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md index 200bfa00a0..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. @@ -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 diff --git a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md index 6ffb96c559..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,9 +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. -Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://docs.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). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -269,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 @@ -335,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 @@ -604,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 @@ -1139,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 diff --git a/exchange/exchange-ps/exchange/New-MoveRequest.md b/exchange/exchange-ps/exchange/New-MoveRequest.md index fc530b6eed..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 @@ -18,7 +18,7 @@ Use the New-MoveRequest cmdlet to begin the process of an asynchronous mailbox o **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 ] @@ -240,6 +244,7 @@ New-MoveRequest [-Identity] -TargetDeliveryDomain [-ProxyToMailbox ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -250,7 +255,7 @@ New-MoveRequest [-Identity] -TargetDeliveryDomain ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -340,7 +345,7 @@ Accept wildcard characters: False ### -RemoteCredential The RemoteCredential parameter specifies the username and password of 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 @@ -432,7 +437,7 @@ Accept wildcard characters: False ``` ### -TargetDeliveryDomain -The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote or RemoteLegacy parameter. +The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is allowed only when performing remote moves with the Remote, RemoteLegacy, or Outbound parameter. ```yaml Type: Fqdn @@ -599,14 +604,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 @@ -813,8 +818,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 Server: [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 Server: [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. @@ -1076,17 +1081,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: MigrationOutbound, MigrationRemote, MigrationRemoteLegacy, MigrationLocal, MigrationRemoteCrossTenant +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 diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md index d2f4b76894..8be7fb364c 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/New-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-OMEConfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/new-omeconfiguration applicable: Exchange Online title: New-OMEConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-OMEConfiguration cmdlet to create a Microsoft Purview Message Encryption 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 @@ -39,7 +39,7 @@ New-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 @@ -75,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 @@ -139,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. diff --git a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md index 72ac696ace..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 diff --git a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md index f70f97172e..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 @@ -46,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 @@ -78,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 @@ -101,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 @@ -117,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 @@ -133,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 @@ -152,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 @@ -168,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 @@ -184,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 @@ -200,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 diff --git a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md index 567545ecc7..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 @@ -290,13 +290,13 @@ The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. - RemoteInbound - RemoteOutbound -For more information, see [Cross-tenant mailbox migration](https://docs.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). +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 @@ -315,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 @@ -336,13 +336,13 @@ The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrati 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://docs.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). +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 @@ -363,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 @@ -385,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 @@ -418,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 @@ -430,13 +430,13 @@ Accept wildcard characters: False ### -OAuthApplicationId This parameter is available only in the cloud-based service. -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://docs.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). +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 @@ -452,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 @@ -471,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 @@ -487,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 @@ -503,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 @@ -519,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 @@ -537,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 @@ -553,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 diff --git a/exchange/exchange-ps/exchange/New-OrganizationSegment.md b/exchange/exchange-ps/exchange/New-OrganizationSegment.md index 8919584389..a8a7015875 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/New-OrganizationSegment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-organizationsegment +online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationsegment applicable: Security & Compliance title: New-OrganizationSegment schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-OrganizationSegment ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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). +- 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). @@ -144,6 +144,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 2cd776554c..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -81,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) @@ -98,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. @@ -269,10 +271,12 @@ 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 @@ -288,10 +292,12 @@ Accept wildcard characters: False ``` ### -SenderRewritingEnabled -The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewritting are rewritten for traffic to on-premises. This parameter is only effective for OnPremises connectors as Partner connectors already have SRS rewritting enabled. Valid values are: +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. -- $true: Messages are rewritten by SRS if they need to be before being 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 rewritten by SRS before being routed through the on-premises messaging system. This is the default value. +This parameter is effective only for OnPremises connectors. ```yaml Type: Boolean @@ -310,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"`. @@ -350,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 @@ -390,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 diff --git a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md index 88d0d2bedd..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 diff --git a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md index 72b57deb5c..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 diff --git a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md index f19a8e13f5..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. diff --git a/exchange/exchange-ps/exchange/New-PartnerApplication.md b/exchange/exchange-ps/exchange/New-PartnerApplication.md index 6d194b146c..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 @@ -16,7 +16,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md index c5c59d14b5..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 +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 PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 +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 +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 +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 +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 +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 +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md index cd258f0edf..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. diff --git a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md index 92ec354132..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 @@ -41,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 @@ -175,7 +175,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-ProtectionAlert.md b/exchange/exchange-ps/exchange/New-ProtectionAlert.md index 0db0b6844f..5c469a4905 100644 --- a/exchange/exchange-ps/exchange/New-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/New-ProtectionAlert.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-protectionalert +online version: https://learn.microsoft.com/powershell/module/exchange/new-protectionalert applicable: Security & Compliance title: New-ProtectionAlert schema: 2.0.0 @@ -12,11 +12,21 @@ ms.reviewer: # New-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. Alert policies contain conditions that define the user activities to monitor, and the notification options for email alerts and entries in the Microsoft Purview compliance portal. +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,17 +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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,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 @@ -232,6 +250,22 @@ 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 }} @@ -284,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). +- 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: @@ -370,7 +404,7 @@ 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 @@ -425,7 +459,7 @@ 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 @@ -479,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. @@ -498,6 +532,54 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Severity The Severity parameter specifies the severity of the detection. Valid values are: @@ -554,6 +636,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VolumeThreshold {{ Fill VolumeThreshold Description }} diff --git a/exchange/exchange-ps/exchange/New-PublicFolder.md b/exchange/exchange-ps/exchange/New-PublicFolder.md index 32fcd4d829..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 diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md index 6efa82e8c1..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 diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md index 0b7dbe3e15..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 ``` diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md index 98ffe23fee..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,9 +47,9 @@ New-PublicFolderMigrationRequest [[-Name] ] -SourceDatabase -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,7 +141,7 @@ Accept wildcard characters: False ``` ### -AllowLargeItems -The AllowLargeItems switch specifies that you can move large items only when large items are encountered. You don't need to specify a value with this switch. +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. @@ -147,7 +149,7 @@ Large items are email messages with a maximum of 1,023 attachments. 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 @@ -157,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 @@ -175,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 @@ -200,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 @@ -210,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 @@ -232,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 @@ -248,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 @@ -257,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: @@ -273,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 @@ -296,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 @@ -314,7 +336,7 @@ If you use this switch, the request is queued, but the request won't reach the s 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 @@ -330,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 @@ -340,6 +362,8 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete +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. @@ -364,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 @@ -374,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 diff --git a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md index 277f9e90d5..2ce42db98f 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-quarantinepermissions +online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepermissions applicable: Exchange Online, Exchange Online Protection title: New-QuarantinePermissions schema: 2.0.0 @@ -14,28 +14,31 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-QuarantinePermissions cmdlet to create quarantine permissions objects to use with the New-QuarantineTag cmdlet. +**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. -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-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 - [-PermissionToBlockSender ] - [-PermissionToDelete ] - [-PermissionToDownload ] - [-PermissionToPreview ] - [-PermissionToRelease ] - [-PermissionToRequestRelease ] - [-PermissionToViewHeader ] + [[-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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,35 +47,54 @@ You need to be assigned permissions before you can run this cmdlet. Although thi $NoAccess = New-QuarantinePermissions ``` -This example creates the same permissions that are used by the No access permissions group in quarantine tags in the Security & Compliance. The permissions object is stored in the variable named `$NoAccess`. +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 Windows PowerShell session, you can use `$NoAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command. +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 -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true +$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 tags in the Security & Compliance. The permissions object is stored in the variable named `$LimitedAccess`. +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 Windows PowerShell session, you can use `$LimitedAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command. +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 -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true +$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 tags in the Security & Compliance. The permissions object is stored in the variable named `$FullAccess`. +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 Windows PowerShell session, you can use `$FullAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command. +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: The Block sender button is included in end-user quarantine notifications. -- $false: The Block sender button is not included in end-user quarantine notifications. This is the default value. +- $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 @@ -81,7 +103,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -90,8 +112,8 @@ Accept wildcard characters: False ### -PermissionToDelete The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: -- $true: The Remove from quarantine button is included in the quarantined message details. -- $false: The Remove from quarantine button is not included in the quarantined message details. This is the default value. +- $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 @@ -100,7 +122,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -112,7 +134,7 @@ The PermissionToDownload parameter specifies whether users are allowed to downlo - $true: The permission is enabled. - $false: The permission is disabled. This is the default value. -Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details. +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 @@ -121,7 +143,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -130,8 +152,8 @@ Accept wildcard characters: False ### -PermissionToPreview The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: -- $true: The Preview message button is included in the quarantined message details. -- $false: The Preview message button is not included in the quarantined message details. This is the default value. +- $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 @@ -140,17 +162,17 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +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 messages from quarantine. Valid values are: +The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: -- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details. -- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value. +- $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. @@ -161,7 +183,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -170,8 +192,8 @@ 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: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details. -- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value. +- $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. @@ -182,7 +204,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -194,7 +216,7 @@ The PermissionToViewHeader parameter specifies whether users are allowed to view - $true: The permission is enabled. - $false: The permission is disabled. This is the default value. -Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details. The View message header button is always available in the quarantined message details. +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 @@ -203,7 +225,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md index 83f7d17575..1d12b70c98 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-quarantinepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepolicy applicable: Exchange Online, Exchange Online Protection title: New-QuarantinePolicy schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,22 +31,26 @@ New-QuarantinePolicy [-Name] [-DomainController ] [-EndUserQuarantinePermissions ] [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] [-EndUserSpamNotificationFrequencyInDays ] [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] [-ESNEnabled ] + [-IncludeMessagesFromBlockedSenderAddress ] [-MultiLanguageCustomDisclaimer ] [-MultiLanguageSenderName ] [-MultiLanguageSetting ] [-OrganizationBrandingEnabled ] + [-QuarantinePolicyType ] [-QuarantineRetentionDays ] - [-QuarantinePolicyType ] [] ``` ## DESCRIPTION -Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -191,7 +195,11 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissions -This parameter is reserved for internal Microsoft use. +**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 @@ -211,23 +219,25 @@ The EndUserQuarantinePermissionsValue parameter specifies the end-user permissio 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** button in the details of the quarantined message. -- PermissionToDownload: This setting is not used (the value 0 or 1 does nothing). -- PermissionToAllowSender: This setting is not used (the value 0 or 1 does nothing). +- 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 1. Set one to 1 and the other to 0, or set both to 0. -- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to 1. Set one to 1 and the other to 0, or set both to 0. +- 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 = 00011011, so use the decimal value 27. -- Full access: Binary = 00010111, so use the decimal value 23. +- 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) @@ -241,6 +251,44 @@ 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. @@ -274,11 +322,35 @@ 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.S +- $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 @@ -293,6 +365,25 @@ 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. @@ -377,7 +468,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: QuarantinePolicyTypeEnum +Type: QuarantinePolicyType Parameter Sets: (All) Aliases: Accepted values: QuarantinePolicy, GlobalQuarantinePolicy diff --git a/exchange/exchange-ps/exchange/New-ReceiveConnector.md b/exchange/exchange-ps/exchange/New-ReceiveConnector.md index 574353b264..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 diff --git a/exchange/exchange-ps/exchange/New-RemoteDomain.md b/exchange/exchange-ps/exchange/New-RemoteDomain.md index 5e5092381c..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 diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/exchange/New-RemoteMailbox.md index af4c7c790f..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 ``` @@ -367,7 +369,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -620,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 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 aa6e9e1335..80238a5236 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy applicable: Security & Compliance title: New-RetentionCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-RetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. +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,16 +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] @@ -53,8 +57,11 @@ New-RetentionCompliancePolicy [-Name] [-Confirm] [-Enabled ] [-Force] + [-IsSimulation] + [-PriorityCleanup] [-RestrictiveRetention ] [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] [-TeamsChannelLocation ] [-TeamsChannelLocationException ] [-TeamsChatLocation ] @@ -66,20 +73,24 @@ 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -88,16 +99,18 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" ``` -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. +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 retention rule to the retention policy. +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 cloud attachment policy named Marketing Department with the specified details. +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 @@ -147,7 +160,7 @@ The Applications parameter specifies the target when Microsoft 365 Groups are in ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: Default, AdaptiveScopeLocation Aliases: Applicable: Security & Compliance @@ -289,6 +302,24 @@ 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 +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: @@ -343,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"`. @@ -361,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"`. @@ -378,8 +409,28 @@ 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 -{{ Fill PolicyTemplateInfo Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable @@ -394,6 +445,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PublicFolderLocation The PublicFolderLocation parameter specifies that you want to include all public folders in the retention policy. You use the value All for this parameter. @@ -465,11 +532,11 @@ 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 @@ -485,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"`. @@ -502,6 +569,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkypeLocation The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy. diff --git a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md index 81afa53cfe..c7471abe72 100644 --- a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancerule applicable: Security & Compliance title: New-RetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,7 +65,7 @@ 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 @@ -117,10 +117,14 @@ The IsDefault switch specifies that this retention policy is the default retenti 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 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: Changes to which retention policy is the default are ignored. The retention policy specified in the mailbox plan is assigned to new mailboxes, and changing which policy is specified in the mailbox plan doesn't affect existing mailboxes. If you set the value back to blank, new mailboxes will use the default policy going forward. Existing mailboxes created during the time when a retention policy was specified in the mailbox plan will continue to use that policy, and are unaffected by changes to which retention policy is the default. Any existing mailboxes that you created during the last time when there was no retention policy specified in the mailbox plan will be continually affected by changes to which retention policy is the default. +- 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 diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md index 2570b9e223..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 diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md index 59d4e83adb..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 @@ -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 diff --git a/exchange/exchange-ps/exchange/New-RoleGroup.md b/exchange/exchange-ps/exchange/New-RoleGroup.md index feaea4f3f1..308719a319 100644 --- a/exchange/exchange-ps/exchange/New-RoleGroup.md +++ b/exchange/exchange-ps/exchange/New-RoleGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-rolegroup +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 @@ -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, 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. @@ -332,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 @@ -406,7 +408,7 @@ 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[] diff --git a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md index 5a07a7266c..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 diff --git a/exchange/exchange-ps/exchange/New-RpcClientAccess.md b/exchange/exchange-ps/exchange/New-RpcClientAccess.md index 0247859e72..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 diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index 9322dfba61..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,14 +16,13 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] @@ -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,15 @@ 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 the **Off** selection for the **Safe Attachments unknown malware response** setting of the policy in the Microsoft 365 Defender portal. +- $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 Microsoft 365 Defender portal (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 @@ -180,7 +159,7 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -{{ Fill MakeBuiltInProtection Description }} +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 @@ -196,19 +175,23 @@ Accept wildcard characters: False ``` ### -QuarantineTag -The QuarantineTag 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: +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. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -218,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 @@ -234,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 @@ -253,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 @@ -275,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 diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md index 50401a89b0..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,12 +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/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 or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Safe Attachments policy settings](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-attachments#safe-attachments-policy-settings). +> 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 @@ -70,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 @@ -94,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 @@ -110,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 @@ -129,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 @@ -141,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. @@ -150,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 @@ -160,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 @@ -191,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 @@ -218,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 @@ -242,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 @@ -252,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 @@ -283,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 @@ -310,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 @@ -326,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 diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index 95db53e7d7..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links t 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 @@ -72,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 @@ -88,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 @@ -100,14 +100,16 @@ Accept wildcard characters: False ### -AllowClickThrough 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. This is the default value. +- $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 @@ -173,14 +175,16 @@ Accept wildcard characters: False ### -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). Typically, we don't recommend using this 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 @@ -214,14 +218,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 @@ -233,14 +237,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 @@ -252,14 +256,14 @@ Accept wildcard characters: False ### -EnableSafeLinksForEmail The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for email. 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. 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 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 @@ -271,7 +275,7 @@ Accept wildcard characters: False ### -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. 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. +- $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. @@ -280,7 +284,7 @@ Note that this protection applies to links in Office documents, not links in ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -292,14 +296,14 @@ Accept wildcard characters: False ### -EnableSafeLinksForTeams The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. 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 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 @@ -309,13 +313,13 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -This parameter is reserved for internal Microsoft use. +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, 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, including links that point to files, is enabled. -- $false: Real-time scanning of clicked links, 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 @@ -369,7 +373,7 @@ The TrackClicks parameter specifies whether to track user clicks related to Safe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -388,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 @@ -404,7 +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 +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/exchange/New-SafeLinksRule.md index 221d643e0e..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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. > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Recipient filters in Safe Links policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-links#recipient-filters-in-safe-links-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,9 @@ This example creates a Safe Links rule named Contoso All with the following cond ### Example 3 ```powershell $Data = Import-Csv -Path "C:\Data\SafeLinksDomains.csv" + $SLDomains = $Data.Domains + New-SafeLinksRule -Name "Contoso All" -SafeLinksPolicy "Contoso All" -RecipientDomainIs $SLDomains ``` @@ -91,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 @@ -115,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 @@ -131,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 @@ -150,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 @@ -171,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 @@ -181,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 @@ -212,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 @@ -239,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 @@ -263,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 @@ -273,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 @@ -304,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 @@ -331,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 @@ -347,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 diff --git a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md index 24b3a4af4c..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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 +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 +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 +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 +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 +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 @@ -138,7 +174,7 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md deleted file mode 100644 index 92f1152dc2..0000000000 --- a/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-secopsoverriderule -applicable: Security & Compliance -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 PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 - -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 - -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 -``` - -### -SentTo -This parameter is reserved for internal Microsoft use. - -```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 -``` - -### -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-SendConnector.md b/exchange/exchange-ps/exchange/New-SendConnector.md index 6bf4012728..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. @@ -312,7 +313,7 @@ The usage type specifies the permissions and authentication methods assigned to - 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 @@ -529,7 +530,7 @@ The usage type specifies the permissions and authentication methods assigned to - 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 @@ -554,7 +555,7 @@ The usage type specifies the permissions and authentication methods assigned to - 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 @@ -672,7 +673,7 @@ The usage type specifies the permissions and authentication methods assigned to - 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 @@ -906,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 diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index b849a7a77b..6e59edbe3e 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-serviceprincipal -applicable: Exchange Online +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 @@ -16,12 +16,13 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 -ServiceId +New-ServicePrincipal -AppId -ObjectId + -ServiceId [-Confirm] [-DisplayName ] [-Organization ] @@ -30,32 +31,36 @@ New-ServicePrincipal -AppId -ServiceId ``` ## DESCRIPTION -Service principals exist in Azure Active Directory 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 Azure AD. To assign Exchange Online role-based access control (RBAC) roles to service principals in Azure AD, 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. +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 Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 -ServiceId 6233fba6-0198-4277-892f-9275bf728bcc +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 ServiceId values. +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. +The AppId parameter specifies the unique AppId GUID value for the service principal. For example, ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. -To find the AppId value of the Azure AD service principal, use the Get-AzADApplication cmdlet in the Azure Az PowerShell module. For installation instructions, see [Install the Azure Az PowerShell module](https://docs.microsoft.com/powershell/azure/install-az-ps). +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 @@ -64,15 +69,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceId -The ServiceId parameter specifies the unique ServiceID GUID value for the service principal. For example, 7c7599b2-23af-45e3-99ff-0025d148e929. +### -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 -To find the ServiceId value of the Azure AD service principal, use the Get-AzADApplication cmdlet in the Azure Az PowerShell module. For installation instructions, see [Install the Azure Az PowerShell module](https://docs.microsoft.com/powershell/azure/install-az-ps). +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 @@ -91,6 +116,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 @@ -106,6 +132,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -121,6 +148,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -136,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 diff --git a/exchange/exchange-ps/exchange/New-SettingOverride.md b/exchange/exchange-ps/exchange/New-SettingOverride.md index 3db6a8f61a..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,6 +53,22 @@ This example creates a default sharing policy, which is applied to all mailboxes ## PARAMETERS +### -Name +The Name parameter specifies the name of the new sharing policy. + +```yaml +Type: String +Parameter Sets: (All) +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: False +Accept wildcard characters: False +``` + ### -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'`. @@ -82,22 +100,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of the new sharing policy. - -```yaml -Type: String -Parameter Sets: (All) -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: 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. diff --git a/exchange/exchange-ps/exchange/New-SiteMailbox.md b/exchange/exchange-ps/exchange/New-SiteMailbox.md index 71d48d5d80..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 @@ -166,7 +162,7 @@ This switch tests that site mailbox provisioning is working independently of 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 @@ -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 diff --git a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md index f03369600f..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 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 diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md index 30d20adff9..ed8687d950 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 +online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 applicable: Security & Compliance title: New-SupervisoryReviewPolicyV2 schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,13 +26,15 @@ New-SupervisoryReviewPolicyV2 [-Name] -Reviewers [-Confirm] [-Enabled ] [-Force] + [-PolicyRBACScopes ] + [-PreservationPeriodInDays ] [-UserReportingWorkloads ] [-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://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 @@ -146,6 +148,38 @@ 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 }} diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md index 40302e4310..c4b9d1a57f 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule applicable: Security & Compliance title: New-SupervisoryReviewRule schema: 2.0.0 @@ -12,30 +12,43 @@ ms.reviewer: # New-SupervisoryReviewRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,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 }} @@ -198,6 +227,166 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ocr {{ Fill Ocr Description }} @@ -214,6 +403,22 @@ 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 +``` + ### -SamplingRate The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. @@ -230,6 +435,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/New-SweepRule.md b/exchange/exchange-ps/exchange/New-SweepRule.md index 3b36146b86..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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 diff --git a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md index 1f4171f666..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 @@ -99,7 +99,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -518,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: diff --git a/exchange/exchange-ps/exchange/New-SystemMessage.md b/exchange/exchange-ps/exchange/New-SystemMessage.md index 91bc75f739..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: 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 a25cc3000f..6ef2975372 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-tenantallowblocklistitems +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 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS 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. +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 @@ -26,8 +26,10 @@ New-TenantAllowBlockListItems -Entries -ListType [-Expirat [-Allow] [-Block] [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] [-SubmissionID ] [] ``` @@ -38,14 +40,16 @@ New-TenantAllowBlockListItems -Entries -ListType [-NoExpir [-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 @@ -68,22 +72,46 @@ This example adds a file block entry for the specified files that never expires. New-TenantAllowBlockListItems -Allow -ListType Url -ListSubType AdvancedDelivery -Entries *.fabrikam.com -NoExpiration ``` -This example adds a URL allow entry for the specified third-party phishing simulation URL with no expiration. 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). +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). + +### Example 4 +```powershell +New-TenantAllowBlockListItems -Allow -ListType Url -Entries abcd.fabrikam.com -RemoveAfter 45 +``` + +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). + +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 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. 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`. +- 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://docs.microsoft.com/microsoft-365/security/office-365-security/allow-block-urls#url-syntax-for-the-tenant-allowblock-list). +- 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: + + • 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 value types (file, sender, or URL) or allow and block actions in the same command. +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. -In most cases, you can't modify the URL, file, or sender values after you create the entry. The only exception is allow URL entries for phishing simulations (ListType = URL, ListSubType = AdvancedDelivery). +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[] @@ -99,14 +127,14 @@ 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 @@ -127,6 +155,7 @@ The ListType parameter specifies the type of entry to add. Valid values are: - FileHash - Sender - Url +- IP ```yaml Type: ListType @@ -148,8 +177,9 @@ 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 parameter. +You can't use this switch with the ExpirationDate or RemoveAfter parameter. ```yaml Type: SwitchParameter @@ -169,11 +199,15 @@ The Allow switch specifies that you're creating an allow entry. You don't need t 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, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,13 +237,29 @@ 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 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). +- 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 @@ -235,6 +285,28 @@ 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 +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. @@ -260,7 +332,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md index 97efa57c4e..48976dd565 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-tenantallowblocklistspoofitems +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 @@ -16,13 +16,12 @@ This cmdlet is available only in the cloud-based service. Use the New-TenantAllowBlockListSpoofItems cmdlet to create spoofed sender entries in the Tenant Allow/Block 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 ``` -New-TenantAllowBlockListSpoofItems [-Identity] -Action - -SendingInfrastructure -SpoofedUser -SpoofType +New-TenantAllowBlockListSpoofItems [-Identity] -Action -SendingInfrastructure -SpoofedUser -SpoofType [-Confirm] [-WhatIf] [] @@ -31,7 +30,7 @@ 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 @@ -86,6 +85,8 @@ The SpoofedUser parameter specifies the email address or domain for the spoofed - 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) diff --git a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md index 7d2cf8fec1..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 @@ -2667,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 diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 05f4c612ca..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 @@ -60,8 +66,8 @@ New-TransportRule [-Name] [-ContentCharacterSetContainsWords ] [-CopyTo ] [-DeleteMessage ] - [-Disconnect ] [-DlpPolicy ] + [-Disconnect ] [-DomainController ] [-Enabled ] [-ExceptIfADComparisonAttribute ] @@ -206,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 @@ -243,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 @@ -261,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. @@ -313,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: @@ -336,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: @@ -392,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: @@ -425,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: @@ -456,8 +462,6 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords -**Note**: In the cloud-based service, this parameter behaves the same as the RecipientAddressContainsWords parameter (other recipients in the message are not affected). - 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 available on Mailbox servers and Edge Transport servers. @@ -482,8 +486,6 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns -**Note**: In the cloud-based service, this parameter behaves the same as the RecipientAddressMatchesPatterns parameter (other recipients in the message are not affected). - 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 available on Mailbox servers and Edge Transport servers. @@ -510,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: @@ -543,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: @@ -576,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: @@ -609,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: @@ -642,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. @@ -664,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 added to a message. Valid values are: +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: 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. +- 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. + + 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. @@ -690,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: @@ -715,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 @@ -780,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 ("). @@ -788,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 @@ -806,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. @@ -828,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) @@ -848,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) @@ -871,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. @@ -894,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 @@ -919,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. @@ -943,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"`. @@ -963,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: @@ -988,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: @@ -1059,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: @@ -1088,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: @@ -1181,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. @@ -1276,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 @@ -1333,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. @@ -1385,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: @@ -1408,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: @@ -1441,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: @@ -1474,9 +1521,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords -**Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressContainsWords parameter (other recipients in the message are not affected). - -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. @@ -1500,9 +1545,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns -**Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressMatchesPatterns parameter (other recipients in the message are not affected). - -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. @@ -1526,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: @@ -1559,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: @@ -1592,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: @@ -1625,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: @@ -1658,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. @@ -1680,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) @@ -1700,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) @@ -1723,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. @@ -1746,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 @@ -1771,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. @@ -1795,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"`. @@ -1815,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: @@ -1840,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: @@ -1879,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. @@ -1909,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: @@ -1938,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: @@ -1967,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. @@ -1989,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: @@ -2020,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. @@ -2042,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. @@ -2050,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) @@ -2064,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: @@ -2095,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 @@ -2118,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. @@ -2144,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: @@ -2167,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: @@ -2190,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. @@ -2210,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. @@ -2234,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. @@ -2254,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. @@ -2276,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: @@ -2307,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: @@ -2332,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[] @@ -2356,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. @@ -2386,14 +2443,14 @@ 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. +- 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 using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -2416,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. @@ -2472,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. @@ -2526,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. @@ -2546,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"`. @@ -2568,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[] @@ -2608,11 +2665,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -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 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: @@ -2635,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. @@ -2691,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. @@ -2745,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). @@ -2787,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: @@ -2799,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) @@ -2813,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: @@ -2836,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: @@ -2865,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: @@ -2892,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 @@ -2917,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[] @@ -2939,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. @@ -2959,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[] @@ -2981,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. @@ -3001,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: @@ -3025,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 @@ -3047,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: @@ -3106,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) @@ -3122,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: @@ -3157,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 @@ -3176,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: @@ -3187,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 @@ -3205,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: @@ -3218,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) @@ -3234,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. @@ -3260,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: @@ -3281,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: @@ -3392,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. @@ -3402,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. @@ -3435,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: @@ -3486,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: @@ -3517,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: @@ -3540,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. @@ -3598,12 +3665,12 @@ 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. +- 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 using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3628,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 @@ -3648,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: @@ -3673,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: @@ -3702,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: @@ -3789,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) @@ -3805,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. @@ -3861,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. @@ -3915,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. @@ -3935,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"`. @@ -3959,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 @@ -3978,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[] @@ -4047,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. @@ -4073,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". @@ -4167,7 +4242,12 @@ This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. -{{ Fill RemoveRMSAttachmentEncryption Description }} +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 @@ -4209,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: @@ -4251,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 @@ -4268,11 +4348,9 @@ Accept wildcard characters: False ``` ### -SCLOver -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. -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: @@ -4297,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. @@ -4353,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. @@ -4407,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 @@ -4435,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). @@ -4477,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: @@ -4487,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) @@ -4503,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: @@ -4526,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: @@ -4555,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: @@ -4586,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 @@ -4611,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: @@ -4770,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[] @@ -4812,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[] @@ -4885,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: diff --git a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md b/exchange/exchange-ps/exchange/New-UMAutoAttendant.md index b8b04a2b52..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 diff --git a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md index 07f4bc7536..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 diff --git a/exchange/exchange-ps/exchange/New-UMDialPlan.md b/exchange/exchange-ps/exchange/New-UMDialPlan.md index 977a832115..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 diff --git a/exchange/exchange-ps/exchange/New-UMHuntGroup.md b/exchange/exchange-ps/exchange/New-UMHuntGroup.md index 08cf7c5cec..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 diff --git a/exchange/exchange-ps/exchange/New-UMIPGateway.md b/exchange/exchange-ps/exchange/New-UMIPGateway.md index d13366abe8..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 diff --git a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md index 7b492740c5..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 diff --git a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md index 43da7e48ba..2196b0f833 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy applicable: Security & Compliance title: New-UnifiedAuditLogRetentionPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. +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 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 Purview compliance portal](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. @@ -75,7 +75,7 @@ The Priority parameter specifies a priority value for the policy that determines 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://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). +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 @@ -149,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"`. @@ -169,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. diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/exchange/New-UnifiedGroup.md index ae54f5de6d..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**: 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). You can use Microsoft Graph instead. For more information, see [Create group](https://docs.microsoft.com/graph/api/group-post-groups). +**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 @@ -126,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 @@ -148,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 @@ -177,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 @@ -190,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. @@ -200,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 @@ -215,7 +215,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -229,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 @@ -252,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 @@ -270,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 @@ -286,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 @@ -305,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 @@ -327,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 @@ -347,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 @@ -365,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 @@ -375,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: @@ -396,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 @@ -412,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 @@ -424,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 @@ -444,13 +443,13 @@ The HiddenGroupMembershipEnabled switch specifies whether to hide the members of 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 @@ -466,7 +465,7 @@ Accept wildcard characters: False Type: System.Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -478,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 @@ -494,15 +493,13 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is available only in the cloud-based service. - 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 @@ -518,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 @@ -543,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 @@ -561,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 @@ -577,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 @@ -602,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 @@ -618,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 @@ -637,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 @@ -647,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 @@ -671,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 @@ -687,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 @@ -703,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 diff --git a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md index cc081dbaaf..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 @@ -343,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 @@ -361,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 diff --git a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md index b1fd21161b..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 diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index 712516a368..655b0da6f5 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/preview-quarantinemessage +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 @@ -16,18 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -65,14 +66,35 @@ 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 -{{ Fill RecipientAddress Description }} +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Redirect-Message.md b/exchange/exchange-ps/exchange/Redirect-Message.md index c9664a801f..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 diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index 689efe70a3..17f3d5590b 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/release-quarantinemessage +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 @@ -18,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Release-QuarantineMessage -User [-Identities ] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -40,6 +41,7 @@ Release-QuarantineMessage [-Identities ] [-Identity [-ReleaseToAll] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -53,6 +55,7 @@ Release-QuarantineMessage -Identities [-ActionType ] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -64,6 +67,7 @@ Release-QuarantineMessage -Identities Release-QuarantineMessage -Identity [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -73,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 @@ -101,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 @@ -217,9 +222,8 @@ Accept wildcard characters: False ### -ActionType The ActionType parameter specifies the release action type. Valid values are: -- Approve - Deny -- Release +- Release: Use this value to release messages or approve requests to release messages. - Request ```yaml @@ -272,6 +276,27 @@ 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 +``` + ### -Force The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. @@ -291,9 +316,9 @@ 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 diff --git a/exchange/exchange-ps/exchange/Remove-ADPermission.md b/exchange/exchange-ps/exchange/Remove-ADPermission.md index 16ed3fdcdb..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 ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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" +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. @@ -58,7 +58,7 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -77,7 +77,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 +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 diff --git a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md b/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md index b1d20dbb79..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 diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md index 3343d72b2f..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 diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md index 83735dc9ec..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 diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md index 16affd8ab5..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 diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md index 0c25d86b6f..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 diff --git a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md b/exchange/exchange-ps/exchange/Remove-ActivityAlert.md deleted file mode 100644 index 9727a4e87f..0000000000 --- a/exchange/exchange-ps/exchange/Remove-ActivityAlert.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-activityalert -applicable: Security & Compliance -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 PowerShell. For more information, see [Security & Compliance 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 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). - -## SYNTAX - -``` -Remove-ActivityAlert [-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 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft Purview compliance portal](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 - -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 - -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 - -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-AdaptiveScope.md b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md index 41585eed84..6716aabc5e 100644 --- a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-adaptivescope +online version: https://learn.microsoft.com/powershell/module/exchange/remove-adaptivescope applicable: Security & Compliance title: Remove-AdaptiveScope schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AdaptiveScope ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-AdaptiveScope [-Identity] ``` ## 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://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 diff --git a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md index 135ac4fecd..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 diff --git a/exchange/exchange-ps/exchange/Remove-AddressList.md b/exchange/exchange-ps/exchange/Remove-AddressList.md index 190d0891e6..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 diff --git a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md index db59d82f81..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 diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md index 5ff87051db..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md b/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md index ede4e328b3..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-App.md b/exchange/exchange-ps/exchange/Remove-App.md index 976c4b3712..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. diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md index b251bd8abc..c470a3f9f2 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-appretentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancepolicy applicable: Security & Compliance title: Remove-AppRetentionCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AppRetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AppRetentionCompliancePolicy to remove app retention compliance 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,16 +29,16 @@ Remove-AppRetentionCompliancePolicy [-Identity] ``` ## 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://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 -Remove-AppRetentionCompliancePolicy -Identity "Contoso Yammer" +Remove-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" ``` -This example removes the app retention compliance policy named Contoso Yammer. +This example removes the app retention compliance policy named Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md index 1458016d53..724cda7063 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancerule applicable: Security & Compliance title: Remove-AppRetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AppRetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AppRetentionComplianceRule to remove app retention compliance 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 @@ -29,16 +29,16 @@ Remove-AppRetentionComplianceRule [-Identity] ``` ## 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://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 -Remove-AppRetentionComplianceRule -Identity "Contoso Yammer" +Remove-AppRetentionComplianceRule -Identity "Contoso Viva Engage" ``` -This example removes the app retention compliance policy rule Contoso Yammer. +This example removes the app retention compliance policy rule Contoso Viva Engage. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md index 45f7d2e541..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -77,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 diff --git a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md index 0d54c01241..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. diff --git a/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md deleted file mode 100644 index a5455b847b..0000000000 --- a/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md +++ /dev/null @@ -1,121 +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 -title: Remove-AuditConfigurationPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 - -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 - -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 - -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: 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/Remove-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-AuditConfigurationRule.md deleted file mode 100644 index 403a883f98..0000000000 --- a/exchange/exchange-ps/exchange/Remove-AuditConfigurationRule.md +++ /dev/null @@ -1,121 +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 -title: Remove-AuditConfigurationRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 - -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 - -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 - -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: 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/Remove-AuthRedirect.md b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md index cb9eab3359..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,7 +29,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Remove-AuthServer.md b/exchange/exchange-ps/exchange/Remove-AuthServer.md index faafc04257..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 diff --git a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md index 33ad76fa1e..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,19 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -39,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 @@ -61,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. @@ -80,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. diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md index be050548ee..d6b2940550 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy applicable: Security & Compliance title: Remove-AutoSensitivityLabelPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md index d94bff9cd5..f779597117 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule applicable: Security & Compliance title: Remove-AutoSensitivityLabelRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md index 21f540e694..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 diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md index e9c06daceb..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 @@ -42,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 diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md index c60d6065f7..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 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 f362036fc7..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 diff --git a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md index 7662e09c6c..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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md index 35b0b05c84..cb7f9417bd 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-caseholdrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-caseholdrule applicable: Security & Compliance title: Remove-CaseHoldRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md index 3be9496f11..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 @@ -18,7 +18,7 @@ Use the Remove-ClassificationRuleCollection to remove classification rule collec 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 diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md index 14e3ff184b..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 +> [!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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md index f7f453f32e..a636d54a72 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancecase +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecase applicable: Security & Compliance title: Remove-ComplianceCase schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md index 24a975f405..2a22dd2318 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancecasemember +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecasemember applicable: Security & Compliance title: Remove-ComplianceCaseMember schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md index cdcde3f134..fdca44b480 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Remove-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype applicable: Security & Compliance title: Remove-ComplianceRetentionEventType schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md index b88e1e6c8e..92fdcfc7a7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearch +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md index 46b0aa1828..8140168e36 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearchaction +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearchaction applicable: Security & Compliance title: Remove-ComplianceSearchAction schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceSearchAction ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md index 49e1fa93ff..8b38b2ba8a 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter +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 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md index 4150087444..46c293ddf7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancetag +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancetag applicable: Security & Compliance title: Remove-ComplianceTag schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -97,6 +98,22 @@ 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 +``` + ### -WhatIf The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. diff --git a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md index 3b8df8f46b..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 diff --git a/exchange/exchange-ps/exchange/Remove-CustomNudge.md b/exchange/exchange-ps/exchange/Remove-CustomNudge.md deleted file mode 100644 index dcfb43ec54..0000000000 --- a/exchange/exchange-ps/exchange/Remove-CustomNudge.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/remove-customnudge -applicable: Exchange Online -title: Remove-CustomNudge -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Remove-CustomNudge - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Remove-CustomNudge cmdlet to remove Custom Nudges that are displayed in user Briefing email 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). - -## SYNTAX - -``` -Remove-CustomNudge -Name - [-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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Remove-CustomNudge -Name perfReviewNudge -``` - -This example removes the existing Custom Nudge named "perfReviewNudge". - -## PARAMETERS - -### -Name -The Name parameter specifies the name of the Custom Nudge that you want to remove. If the value contains spaces, enclose the value in quotation marks ("). - -```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: 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-CustomNudgeAssignment.md b/exchange/exchange-ps/exchange/Remove-CustomNudgeAssignment.md deleted file mode 100644 index 9b1dc99bd7..0000000000 --- a/exchange/exchange-ps/exchange/Remove-CustomNudgeAssignment.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/remove-customnudgeassignment -applicable: Exchange Online -title: Remove-CustomNudgeAssignment -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Remove-CustomNudgeAssignment - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Remove-CustomNudgeAssignment cmdlet to remove the assignments of Custom Nudges from users. Custom Nudges are shown in the Briefing 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). - -## SYNTAX - -``` -Remove-CustomNudgeAssignment -AssigneeId -NudgeName - [-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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Remove-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId roy@contoso.onmicrosoft.com -``` - -This example removes the assignment of the Custom Nudge named perfReviewNudge from the user roy@contoso.onmicrosoft.com. - -## PARAMETERS - -### -AssigneeId -The AssigneeId parameter specifies the email address of the user in the Custom Nudge assignment that you want to remove. - -Together, this parameter and the AssigneeId parameter uniquely identify the Custom Nudge assignment that you want to remove. - -```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 -``` - -### -NudgeName -The NudgeName parameter specifies the name of the Custom Nudge in the Custom Nudge assignment that you want to remove. If the value contains spaces, enclose the value in quotation marks ("). - -Together, this parameter and the AssigneeId parameter uniquely identify the Custom Nudge assignment that you want to remove. - -```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: 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-DataClassification.md b/exchange/exchange-ps/exchange/Remove-DataClassification.md index 846f7c0a7b..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 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS 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 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 diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md index 0ce0956eb2..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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md index d6aa2fe148..12423d67fd 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy applicable: Security & Compliance title: Remove-DeviceConditionalAccessPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md index 9f9a4c7387..08e72f3b32 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule applicable: Security & Compliance title: Remove-DeviceConditionalAccessRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md index 16828ea6b2..913547d5a2 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy applicable: Security & Compliance title: Remove-DeviceConfigurationPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md index ec8fe97053..d3ab49229c 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule applicable: Security & Compliance title: Remove-DeviceConfigurationRule schema: 2.0.0 @@ -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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md index 28779ebfa9..919b43271d 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy applicable: Security & Compliance title: Remove-DeviceTenantPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md index beb79fb892..0fe5232d12 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantrule applicable: Security & Compliance title: Remove-DeviceTenantRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceTenantRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md b/exchange/exchange-ps/exchange/Remove-DistributionGroup.md index 687d62d8b2..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 diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md index 4d3e36e62b..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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md index 7e14813344..86f93677d8 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy applicable: Security & Compliance title: Remove-DlpCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md index 0cde9397db..cbbfa8b856 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule applicable: Security & Compliance title: Remove-DlpComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md index 2da9adf365..f32281feb1 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Remove-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema applicable: Security & Compliance title: Remove-DlpEdmSchema schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -106,4 +106,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 d35bed6fc6..9497d5484f 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary applicable: Security & Compliance title: Remove-DlpKeywordDictionary schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md b/exchange/exchange-ps/exchange/Remove-DlpPolicy.md index a9225237f8..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 @@ -82,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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md index 98d0aa8e2c..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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md index 50b40ac46c..248e930c45 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype applicable: Security & Compliance title: Remove-DlpSensitiveInformationType schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpSensitiveInformationType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -32,7 +32,7 @@ Sensitive information type rule packages are used by data loss prevention (DLP) **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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md index c1f364d0ea..dcf39f5bd5 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage applicable: Security & Compliance title: Remove-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpSensitiveInformationTypeRulePackage ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 diff --git a/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md deleted file mode 100644 index bbadc713a8..0000000000 --- a/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md +++ /dev/null @@ -1,95 +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 2a814f408e..0000000000 --- a/exchange/exchange-ps/exchange/Remove-EOPMailUser.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-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 index 21889d27b3..ba11d899b1 100644 --- a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-eopprotectionpolicyrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection title: Remove-EOPProtectionPolicyRule schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Remove-EOPProtectionPolicyRule cmdlet to remove rules from Exchange Onli **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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,15 +30,15 @@ Remove-EOPProtectionPolicyRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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" +Remove-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" ``` This example removes the existing rule for EOP protections in the Standard preset security policy. diff --git a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md index c78e901c17..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 diff --git a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md b/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md index db0f9b1df4..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 diff --git a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md index 8bfba32019..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 diff --git a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md index 20613fa28c..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 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/New-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md similarity index 61% rename from exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md rename to exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md index dd3e9f1d24..d6b0f82b35 100644 --- a/exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md @@ -1,64 +1,66 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-featureconfiguration applicable: Security & Compliance -title: New-AuditConfigurationPolicy +title: Remove-FeatureConfiguration schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: --- -# New-AuditConfigurationPolicy +# Remove-FeatureConfiguration ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AuditConfigurationPolicy cmdlet to create audit configuration policies. +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. -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-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 ``` -New-AuditConfigurationPolicy -Workload +Remove-FeatureConfiguration [-Identity] [-Confirm] - [-DomainController ] [-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://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 Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES ### Example 1 ```powershell -New-AuditConfigurationPolicy -Workload SharePoint +Remove-FeatureConfiguration -Identity "Engineering Group" ``` -This example creates an audit configuration policy for Microsoft SharePoint Online. +This example removes the specified feature configuration. ## PARAMETERS -### -Workload -The Workload parameter specifies where auditing is allowed. Valid values are: +### -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: -- Exchange -- OneDriveForBusiness -- SharePoint +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Workload +Type: PolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Security & Compliance Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -81,24 +83,8 @@ 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 - -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. +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 diff --git a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md b/exchange/exchange-ps/exchange/Remove-FederatedDomain.md index 9408d49584..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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md index 041ec05d6e..6de6ae8679 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertyauthority +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md index 5c0c79dca6..e5e7d1c7fa 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertycategory +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md index c498399ce1..70c1f29a20 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertycitation +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md index 8208d80351..630bbe64a4 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertydepartment +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md index 80874b4a9a..7548cc4cf3 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertyreferenceid +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md index 9b329b1400..5e45a1faf5 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertysubcategory +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md b/exchange/exchange-ps/exchange/Remove-ForeignConnector.md index 3a9feefc8a..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 diff --git a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md b/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md index c8afd391b0..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 diff --git a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md index a02f0f500e..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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md index 7c87056e13..5b0fea9c47 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-holdcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-holdcompliancerule applicable: Security & Compliance title: Remove-HoldComplianceRule schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Remove-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md index b891738cd8..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md index 73d02f255e..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md b/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md index 9f136c2a12..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 diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md index 66586130f8..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 diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md index 16d822c8af..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 diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md index 7176ddb1c7..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 diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md index 49c03ac4c6..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 diff --git a/exchange/exchange-ps/exchange/Remove-InboundConnector.md b/exchange/exchange-ps/exchange/Remove-InboundConnector.md index 533b48c45d..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-InboxRule.md b/exchange/exchange-ps/exchange/Remove-InboxRule.md index c82c465584..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 diff --git a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md index 03316a2e1c..daac4a22b1 100644 --- a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy applicable: Security & Compliance title: Remove-InformationBarrierPolicy schema: 2.0.0 @@ -12,25 +12,26 @@ ms.reviewer: # Remove-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,6 +83,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. @@ -109,6 +126,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 f595e979f6..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 diff --git a/exchange/exchange-ps/exchange/Remove-JournalRule.md b/exchange/exchange-ps/exchange/Remove-JournalRule.md index 5ff0870c37..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 diff --git a/exchange/exchange-ps/exchange/Remove-Label.md b/exchange/exchange-ps/exchange/Remove-Label.md index 553cc80365..7b1812a00e 100644 --- a/exchange/exchange-ps/exchange/Remove-Label.md +++ b/exchange/exchange-ps/exchange/Remove-Label.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-label +online version: https://learn.microsoft.com/powershell/module/exchange/remove-label applicable: Security & Compliance title: Remove-Label schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md index 1fdb4fd939..2289247216 100644 --- a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-labelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-labelpolicy applicable: Security & Compliance title: Remove-LabelPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-LabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-MailContact.md b/exchange/exchange-ps/exchange/Remove-MailContact.md index e4d2599919..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 diff --git a/exchange/exchange-ps/exchange/Remove-MailUser.md b/exchange/exchange-ps/exchange/Remove-MailUser.md index 905465ba35..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 @@ -157,8 +157,8 @@ The PermanentlyDelete switch immediately and permanently deletes (purges) the ma **Notes**: -- 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. -- 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 diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/exchange/Remove-Mailbox.md index d9c4e23b21..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 @@ -80,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 @@ -101,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 ``` @@ -108,7 +109,7 @@ 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. @@ -347,7 +348,7 @@ After you disable or remove a mailbox, you can't include it in a discovery searc ```yaml Type: SwitchParameter -Parameter Sets: Identity, StoreMailboxIdentity +Parameter Sets: Identity, StoreMailboxIdentity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md b/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md index a12eae734f..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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md index 72e27ad341..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. diff --git a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md index 7c64127468..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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md index ce9fc4b911..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 @@ -182,8 +189,6 @@ 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`. @@ -194,7 +199,7 @@ When you use this switch, the value of Identity should be the user's primary cal Type: SwitchParameter Parameter Sets: ResetDelegateUserCollection Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -259,10 +264,10 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 index ea63399fca..688966ba55 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxirmaccess +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxirmaccess applicable: Exchange Online title: Remove-MailboxIRMAccess schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Remove-MailboxIRMAccess [-Identity] -User [!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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 +70,7 @@ 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +**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: diff --git a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md index 194ca86a75..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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md index 7e6550c436..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 @@ -86,7 +86,7 @@ Remove-MailboxPermission [-Identity] [-ResetDefault] ## 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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md index 321a279740..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,7 +31,7 @@ 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 @@ -45,6 +45,7 @@ This example removes all mailbox repair requests for the mailbox database EXCH-M ### Example 2 ```powershell Get-MailboxRepairRequest -Database "EXCH-MBX-02" | Format-List Identity + Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5 ``` @@ -53,6 +54,7 @@ This example removes all related mailbox repair requests that have the same `Dat ### Example 3 ```powershell 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 ``` diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md index b62be91b37..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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md index ef1b6e4116..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 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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md index 5c11556a68..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 diff --git a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md index 964125afc5..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 diff --git a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md index cb3c8b9943..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 diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md b/exchange/exchange-ps/exchange/Remove-ManagedFolder.md index 8f2332ab46..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 diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md index fb6cdf1ec5..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 diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRole.md b/exchange/exchange-ps/exchange/Remove-ManagementRole.md index 2aa3818bef..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 @@ -164,9 +164,9 @@ 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. diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md index 06f59ee9bc..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 diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md index b82b093d13..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 @@ -61,7 +61,7 @@ This example forces you to acknowledge the command before proceeding (we didn't ### -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 ("). diff --git a/exchange/exchange-ps/exchange/Remove-ManagementScope.md b/exchange/exchange-ps/exchange/Remove-ManagementScope.md index be1492442d..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 diff --git a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md index bdb3636c45..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 diff --git a/exchange/exchange-ps/exchange/Remove-Message.md b/exchange/exchange-ps/exchange/Remove-Message.md index fb4a679460..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 ("). diff --git a/exchange/exchange-ps/exchange/Remove-MessageClassification.md b/exchange/exchange-ps/exchange/Remove-MessageClassification.md index 4b6f549701..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 diff --git a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md index e799bb7356..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] [] ``` @@ -35,7 +35,7 @@ The Remove-MigrationBatch cmdlet removes a migration batch. All subscriptions ar 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 diff --git a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md index e6e8da0877..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 diff --git a/exchange/exchange-ps/exchange/Remove-MigrationUser.md b/exchange/exchange-ps/exchange/Remove-MigrationUser.md index 7e1e0324f3..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 diff --git a/exchange/exchange-ps/exchange/Remove-MobileDevice.md b/exchange/exchange-ps/exchange/Remove-MobileDevice.md index 6375d7aaaa..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,7 +31,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md index 9732df0523..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 diff --git a/exchange/exchange-ps/exchange/Remove-MoveRequest.md b/exchange/exchange-ps/exchange/Remove-MoveRequest.md index ab003bbb8f..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 diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md index a5e77fcc0f..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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md index b5067700af..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 diff --git a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md index f9e4bef857..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 diff --git a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md index 84de791ba9..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md index 4626ed5800..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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -107,8 +107,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 e46bbf0e65..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md index bf3956caa9..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 diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md b/exchange/exchange-ps/exchange/Remove-OutlookProvider.md index 4df5d39064..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 diff --git a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md index 9c6a3921f1..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 diff --git a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md index e115ae9c09..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 diff --git a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md b/exchange/exchange-ps/exchange/Remove-PartnerApplication.md index 6c20935caa..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 diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md index a3ea433e1a..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 +online version: https://learn.microsoft.com/powershell/module/exchange/remove-phishsimoverridepolicy +applicable: Exchange Online title: Remove-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,29 +12,31 @@ ms.reviewer: # Remove-PhishSimOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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. @@ -49,11 +51,13 @@ The Identity parameter specifies the phishing simulation override policy that yo - 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: Security & Compliance +Applicable: Exchange Online Required: True Position: 0 @@ -72,7 +76,39 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance +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 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 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf +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 +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md index 580bd1b4e3..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) diff --git a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md index 75b640278a..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 diff --git a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md index 231c9eb2a4..f4edc74c13 100644 --- a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-protectionalert +online version: https://learn.microsoft.com/powershell/module/exchange/remove-protectionalert applicable: Security & Compliance title: Remove-ProtectionAlert schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 PowerShell, you need to be assigned 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 diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolder.md b/exchange/exchange-ps/exchange/Remove-PublicFolder.md index b87d656cd4..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 diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md index a33a084823..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 diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md index 5abd67b12f..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 diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md index f375d5f2c8..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 ## 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md index baadb3ca2b..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 diff --git a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md index 62a695a446..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,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-RecipientPermission [-Identity] -AccessRights -Trustee [-Confirm] [-Deny] + [-MultiTrustees ] [-SkipDomainValidationForMailContact] [-SkipDomainValidationForMailUser] [-SkipDomainValidationForSharedMailbox] @@ -34,7 +35,7 @@ Remove-RecipientPermission [-Identity] -AccessRights -LabelName - [] -``` - -## 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://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 - -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 - -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 f6bd837fc7..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 diff --git a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md index 9d8f2de8d2..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 @@ -132,7 +132,7 @@ Accept wildcard characters: False ### -IgnoreLegalHold 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 Azure AD object is removed, but if the mailbox is on hold, the mailbox is converted into an inactive mailbox and remains on hold. +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 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 4ea3b35c21..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 diff --git a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md index f8ff4cce4c..586520eb81 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy applicable: Security & Compliance title: Remove-RetentionCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-RetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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,12 +24,13 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-RetentionCompliancePolicy [-Identity] [-Confirm] [-ForceDeletion] + [-PriorityCleanup] [-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://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 @@ -97,6 +98,22 @@ 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 +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md index ecfb658eae..fd33677240 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule applicable: Security & Compliance title: Remove-RetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -99,6 +100,22 @@ 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 +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md index ec2a7722ce..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 diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md index 99c35af4d9..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 diff --git a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md index 94410c4706..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 diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroup.md b/exchange/exchange-ps/exchange/Remove-RoleGroup.md index 9d83e53e33..ed3cddf995 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Remove-RoleGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-rolegroup +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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md index 88f046a050..34807f1679 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-rolegroupmember +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 @@ -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 @@ -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 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: diff --git a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md index 27fc7271c7..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 diff --git a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md b/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md index f70dea8daa..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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md index 2842c42e68..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -57,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 @@ -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 Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -94,7 +94,7 @@ You can use this switch to run tasks programmatically where prompting for admini 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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md index 94e9ff5023..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -56,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 @@ -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: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md index 6f9454d977..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -59,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 @@ -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 Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -96,7 +96,7 @@ You can use this switch to run tasks programmatically where prompting for admini 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 diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md index 0981dec4a4..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -56,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 @@ -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: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -91,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 diff --git a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md index 2209ee17d3..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 diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md index b3dc46ab73..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 +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 PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 +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 +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 @@ -88,7 +122,7 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SendConnector.md b/exchange/exchange-ps/exchange/Remove-SendConnector.md index 7793c4592d..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 diff --git a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md index 35bfe81468..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 ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,12 +48,13 @@ The Identity parameter specifies the service principal that you want to remove. - Distinguished name (DN) - GUID - AppId -- ServiceId +- ObjectId ```yaml Type: ServicePrincipalIdParameter Parameter Sets: (All) Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -72,6 +73,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 @@ -87,6 +89,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 diff --git a/exchange/exchange-ps/exchange/Remove-SettingOverride.md b/exchange/exchange-ps/exchange/Remove-SettingOverride.md index 13ea8e92eb..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 diff --git a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md b/exchange/exchange-ps/exchange/Remove-SharingPolicy.md index 1f0a6c8827..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 diff --git a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md index 0d2ce09801..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 diff --git a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md b/exchange/exchange-ps/exchange/Remove-StoreMailbox.md index d3c07ec0df..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 diff --git a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md index 50da8ed054..1bbb2eaf31 100644 --- a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 +online version: https://learn.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 applicable: Security & Compliance title: Remove-SupervisoryReviewPolicyV2 schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Remove-SweepRule.md b/exchange/exchange-ps/exchange/Remove-SweepRule.md index a5dd4ffc4c..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 diff --git a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md index 513c7c3e36..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 diff --git a/exchange/exchange-ps/exchange/Remove-SystemMessage.md b/exchange/exchange-ps/exchange/Remove-SystemMessage.md index 7115ac1cf4..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 diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md index e76ef15cb2..131df513a6 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistitems +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 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS 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. +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 @@ -37,7 +37,7 @@ Remove-TenantAllowBlockListItems -Ids -ListType ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 removes the specified URL entry from the Tenant Allow/Block List. 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 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). +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 @@ -63,10 +63,11 @@ The Entries parameter specifies the entries that you want to remove based on the - 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 (file, sender, or URL) or allow and block actions in the same command. +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. @@ -109,6 +110,7 @@ The ListType parameter specifies the type of entry that you want to remove. Vali - FileHash - Sender - Url +- IP ```yaml Type: ListType @@ -133,7 +135,7 @@ The ListSubType specifies further specifies the type of entry that you want to r Type: ListSubType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md index e2a954831e..dffc5da8d0 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistspoofitems +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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-TenantAllowBlockListSpoofItems cmdlet to remove spoofed sender entries from the Tenant Allow/Block 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 @@ -30,7 +30,7 @@ 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 ``` diff --git a/exchange/exchange-ps/exchange/Remove-TransportRule.md b/exchange/exchange-ps/exchange/Remove-TransportRule.md index ba83c81fe5..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 diff --git a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md index 8fc1890293..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 diff --git a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md index c7df0af328..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 diff --git a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md b/exchange/exchange-ps/exchange/Remove-UMDialPlan.md index 9fcd0d98af..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 diff --git a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md b/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md index abbee59f91..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 diff --git a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md b/exchange/exchange-ps/exchange/Remove-UMIPGateway.md index effa926d9f..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 diff --git a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md index e24ee5f505..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 diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md index 70c2698c80..ed810f1d9c 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy applicable: Security & Compliance title: Remove-UnifiedAuditLogRetentionPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. +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 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 Purview compliance portal](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,7 +49,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md index 72e2c0136e..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**: 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). You can use Microsoft Graph instead. For more information, see [Delete group](https://docs.microsoft.com/graph/api/group-delete). +**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 @@ -97,7 +97,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,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 diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md index 9e9509571a..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**: 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). You can use Microsoft Graph instead. For more information, see [Group resource type](https://docs.microsoft.com/graph/api/resources/group). +> [!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 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. -**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. -- **Note**: In Microsoft Graph, the [Remove-MgUserPhoto](https://docs.microsoft.com/powershell/module/microsoft.graph.users/remove-mguserphoto) and [Update-MgUserPhoto](https://docs.microsoft.com/powershell/module/microsoft.graph.users/update-mguserphoto) cmdlets are also available. +**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 @@ -83,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 @@ -106,7 +105,7 @@ Using this switch allows photo requests to search Active Directory for a photo. 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 @@ -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 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 +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 @@ -159,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 @@ -180,7 +177,7 @@ This switch enables the command to access Active Directory objects that aren't c 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 @@ -196,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 @@ -212,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 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 f785d674ba..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 diff --git a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md index dca5fd38c1..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 diff --git a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md index 80f4278681..828137cfb4 100644 --- a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin applicable: Security & Compliance title: Remove-eDiscoveryCaseAdmin schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Remove-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 @@ -32,7 +32,7 @@ An eDiscovery Administrator is member of the eDiscovery Manager role group who c 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md b/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md index 7356e41564..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: @@ -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 diff --git a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md index 5dc5e388f1..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) diff --git a/exchange/exchange-ps/exchange/Restore-Mailbox.md b/exchange/exchange-ps/exchange/Restore-Mailbox.md index 03b1301a65..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 @@ -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. @@ -307,31 +356,18 @@ Accept wildcard characters: False The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: - DeletedItems: The Deleted Items folder. -- DiscoveryHoldsItems: 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. - 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. - -```yaml -Type: RecoverableItemsFolderType -Parameter Sets: OnPrem -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +If you don't use this parameter, the command searches those three folders. -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 diff --git a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md index 456cf80d2b..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 diff --git a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md index 7d79464e44..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 diff --git a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md index 5b786711b3..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 diff --git a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md index ace10d7ad1..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 diff --git a/exchange/exchange-ps/exchange/Resume-Message.md b/exchange/exchange-ps/exchange/Resume-Message.md index 9158efec43..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 ("). diff --git a/exchange/exchange-ps/exchange/Resume-MoveRequest.md b/exchange/exchange-ps/exchange/Resume-MoveRequest.md index 43fc0d3bd2..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." diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md index 2f7b949ee6..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." diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md b/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md index 11fcbb6755..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 diff --git a/exchange/exchange-ps/exchange/Resume-Queue.md b/exchange/exchange-ps/exchange/Resume-Queue.md index b48654f864..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 ("). diff --git a/exchange/exchange-ps/exchange/Retry-Queue.md b/exchange/exchange-ps/exchange/Retry-Queue.md index e28bd27d35..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 ("). diff --git a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md index 2956a77905..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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -82,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: -RSA keys are supported; Ed25519 keys aren't supported. +- 1024 +- 2048 + +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 diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md index 0fe87086e3..f42ad8e781 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/search-adminauditlog +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 @@ -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 } ``` @@ -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**. @@ -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**. diff --git a/exchange/exchange-ps/exchange/Search-Mailbox.md b/exchange/exchange-ps/exchange/Search-Mailbox.md index 797d1abb80..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 @@ -150,7 +150,7 @@ You can't use this switch with the TargetMailbox parameter. 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 @@ -166,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 @@ -195,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 @@ -214,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 @@ -236,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 @@ -246,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 @@ -274,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 @@ -292,7 +290,7 @@ Use this switch to hide the confirmation prompt when you use the DeleteContent s 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 @@ -308,7 +306,7 @@ The IncludeUnsearchableItems switch includes items that couldn't be indexed by E 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 @@ -332,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 @@ -350,7 +348,7 @@ The logging level is specified by using the LogLevel parameter. 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 @@ -368,7 +366,7 @@ By default, the Recoverable Items folder is always included in the search. To 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 Required: False Position: Named @@ -388,7 +386,7 @@ You can also use this switch with the DeleteContent switch to delete messages fr 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 @@ -398,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. @@ -408,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 @@ -424,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 diff --git a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md index 9c198222a8..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,9 +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). + +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 @@ -76,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 @@ -131,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 @@ -206,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 @@ -344,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 diff --git a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md index 535f318556..2044c603f3 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 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS 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). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md index bd57f36a7b..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,9 +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. -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**: 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,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 ] @@ -39,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 Purview compliance portal. 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. @@ -49,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 @@ -102,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. @@ -110,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 @@ -125,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. @@ -133,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 @@ -151,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 @@ -167,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 @@ -183,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 @@ -193,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. @@ -203,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 @@ -213,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"`. @@ -221,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 @@ -231,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 @@ -253,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 @@ -263,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. @@ -274,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 @@ -294,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,13 +350,13 @@ Accept wildcard characters: False ### -SiteIds The SiteIds parameter filters the log entries by the SharePoint SiteId (GUID). You can enter multiple values separated by commas: `Value1, Value2,...ValueN`. -To obtain the 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`. +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 @@ -330,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 diff --git a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md index e0d19b8bdd..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. diff --git a/exchange/exchange-ps/exchange/Set-ADServerSettings.md b/exchange/exchange-ps/exchange/Set-ADServerSettings.md index 321a366cce..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 diff --git a/exchange/exchange-ps/exchange/Set-ADSite.md b/exchange/exchange-ps/exchange/Set-ADSite.md index 0ead5e8e1f..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 diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md index 741f7e33c1..cb0c15498e 100644 --- a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule +applicable: Exchange Online title: Set-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,12 @@ Set-ATPBuiltInProtectionRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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 or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Profiles in preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policiesprofiles-in-preset-security-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 name of the only rule is ATP Built-In Protection Rule. Type: DehydrateableRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -93,7 +93,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 @@ -112,7 +112,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 @@ -122,13 +122,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 @@ -153,7 +153,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 @@ -182,7 +182,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 @@ -198,7 +198,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 diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md index 717954f491..a2820af421 100644 --- a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule +applicable: Exchange Online title: Set-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,12 +37,12 @@ Set-ATPProtectionPolicyRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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 or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Profiles in preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policiesprofiles-in-preset-security-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ By default, the available rules (if they exist) are named Standard Preset Securi Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 0 @@ -91,7 +91,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 @@ -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: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -120,13 +120,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 @@ -151,7 +151,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 @@ -178,7 +178,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 @@ -196,7 +196,7 @@ By default, the rules are named Standard Preset Security Policy or Strict Preset Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -216,7 +216,7 @@ You must use the default value for the rule. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -226,13 +226,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 @@ -257,7 +257,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 @@ -284,7 +284,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 @@ -300,7 +300,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 diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md index 8675c57e54..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. diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md index 888a411f11..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,20 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -53,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 @@ -69,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 @@ -85,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 diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md index a70a33d0a1..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. diff --git a/exchange/exchange-ps/exchange/Set-ActivityAlert.md b/exchange/exchange-ps/exchange/Set-ActivityAlert.md deleted file mode 100644 index 79f2e0317c..0000000000 --- a/exchange/exchange-ps/exchange/Set-ActivityAlert.md +++ /dev/null @@ -1,404 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-activityalert -applicable: Security & Compliance -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 PowerShell. For more information, see [Security & Compliance 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 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). - -## 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 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 Purview compliance portal](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 - -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 - -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 - -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 -``` - -### -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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 - -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-AdSiteLink.md b/exchange/exchange-ps/exchange/Set-AdSiteLink.md index cf36f58ece..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 diff --git a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md index 91da9da62f..6560f5f4ab 100644 --- a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-adaptivescope +online version: https://learn.microsoft.com/powershell/module/exchange/set-adaptivescope applicable: Security & Compliance title: Set-AdaptiveScope schema: 2.0.0 @@ -12,17 +12,18 @@ ms.reviewer: # Set-AdaptiveScope ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] [] ``` @@ -30,19 +31,20 @@ Set-AdaptiveScope [-Identity] -FilterConditions -RawQuery + [-AdministrativeUnit ] [-Comment ] [] ``` -### Identity +### AdministrativeUnit ``` -Set-AdaptiveScope [-Identity] +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://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,10 +77,39 @@ 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" = "CA"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "NotEquals"; "Name" = "Department"}); "Conjunction" = "And"}` +- 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. @@ -97,7 +128,7 @@ Accept wildcard characters: False ``` ### -RawQuery -The RawQuery parameter switches the scope to advanced query mode. You use OPath filter syntax for advanced query mode. +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. diff --git a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md index 5e8899004b..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 diff --git a/exchange/exchange-ps/exchange/Set-AddressList.md b/exchange/exchange-ps/exchange/Set-AddressList.md index ae8fef37e9..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 @@ -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). +- 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 diff --git a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md index 30935023f5..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 diff --git a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md index 7bfa11b523..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. @@ -252,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 @@ -292,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. @@ -314,8 +323,8 @@ 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 diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 8b5286270f..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Set-AntiPhishPolicy -Identity [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] [-Enabled ] [-EnableFirstContactSafetyTips ] [-EnableMailboxIntelligence ] @@ -40,6 +42,7 @@ Set-AntiPhishPolicy -Identity [-EnableViaTag ] [-ExcludedDomains ] [-ExcludedSenders ] + [-HonorDmarcPolicy ] [-ImpersonationProtectionState ] [-MailboxIntelligenceProtectionAction ] [-MailboxIntelligenceProtectionActionRecipients ] @@ -61,7 +64,7 @@ Set-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 @@ -127,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. -- 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 @@ -162,6 +165,50 @@ 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 This parameter is reserved for internal Microsoft use. @@ -204,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: @@ -225,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: @@ -250,7 +297,7 @@ 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: @@ -271,7 +318,7 @@ 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: @@ -292,7 +339,7 @@ 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: @@ -334,7 +381,7 @@ 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: @@ -355,7 +402,7 @@ 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: @@ -385,8 +432,8 @@ The EnableUnauthenticatedSender parameter enables or disables unauthenticated se 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 @@ -402,7 +449,7 @@ 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: @@ -432,8 +479,8 @@ The EnableViaTag parameter enables or disables adding the via tag to the From ad 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 @@ -449,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 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) @@ -469,7 +518,7 @@ 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. @@ -488,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: @@ -511,15 +581,15 @@ 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. -- 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: 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. @@ -538,7 +608,7 @@ 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. @@ -558,7 +628,7 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceQuarantineTag -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 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: @@ -566,7 +636,11 @@ The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -600,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: @@ -645,7 +719,11 @@ The SpoofQuarantineTag specifies the quarantine policy that's used on messages t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -661,7 +739,7 @@ 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. @@ -681,15 +759,15 @@ 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: - 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. -- 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: 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 @@ -706,7 +784,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainQuarantineTag -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 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: @@ -714,7 +792,11 @@ The TargetedDomainQuarantineTag specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -730,7 +812,7 @@ 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. @@ -750,7 +832,7 @@ 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. @@ -770,7 +852,7 @@ 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: @@ -778,7 +860,7 @@ The TargetedUserProtectionAction parameter specifies the action to take on detec - 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. -- 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. +- 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 @@ -795,7 +877,7 @@ Accept wildcard characters: False ``` ### -TargetedUserQuarantineTag -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 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: @@ -803,7 +885,11 @@ The TargetedUserQuarantineTag specifies the quarantine policy that's used on mes - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -819,7 +905,7 @@ 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. @@ -827,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 diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md index 6a12356170..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Set-AntiPhishRule [-Identity] ## DESCRIPTION > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Common policy settings](https://docs.microsoft.com/microsoft-365/security/office-365-security/set-up-anti-phishing-policies#common-policy-settings). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,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[] @@ -236,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[] diff --git a/exchange/exchange-ps/exchange/Set-App.md b/exchange/exchange-ps/exchange/Set-App.md index 67f67a5a69..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: diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md index f39c084313..d7b88cea53 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-appretentioncompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancepolicy applicable: Security & Compliance title: Set-AppRetentionCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-AppRetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AppRetentionCompliancePolicy to modify app retention compliance 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 @@ -30,8 +30,10 @@ Set-AppRetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-Force] + [-PolicyRBACScopes ] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveModernGroupLocation ] @@ -48,6 +50,7 @@ Set-AppRetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-Force] [-RemoveAdaptiveScopeLocation ] @@ -55,13 +58,11 @@ Set-AppRetentionCompliancePolicy [-Identity] [] ``` -### TeamLocation +### DisableRestrictiveRetentionParameterSet ``` Set-AppRetentionCompliancePolicy [-Identity] - [-Comment ] [-Confirm] - [-Enabled ] - [-Force] + [-DeletedResources ] [-WhatIf] [] ``` @@ -70,6 +71,7 @@ Set-AppRetentionCompliancePolicy [-Identity] ``` Set-AppRetentionCompliancePolicy [-Identity] [-Confirm] + [-DeletedResources ] [-Force] [-WhatIf] [] @@ -79,39 +81,80 @@ Set-AppRetentionCompliancePolicy [-Identity] ``` Set-AppRetentionCompliancePolicy [-Identity] [-Confirm] + [-DeletedResources ] [-WhatIf] [] ``` -### DisableRestrictiveRetentionParameterSet +### RetryDistributionParameterSet ``` Set-AppRetentionCompliancePolicy [-Identity] [-Confirm] + [-RetryDistribution] [-WhatIf] [] ``` -### RetryDistributionParameterSet +### TeamLocation ``` Set-AppRetentionCompliancePolicy [-Identity] + [-Comment ] [-Confirm] - [-RetryDistribution] + [-DeletedResources ] + [-Enabled ] + [-Force] [-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://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +\*-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,Yammer" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21" +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 @@ -283,13 +326,31 @@ Accept wildcard characters: False ``` ### -Applications -The Applications parameter specifies the applications to include and is relevant only for the following location parameters: +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: -- ExchangeLocation -- ModernGroupLocation -- AdaptiveScopeLocation + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` -This parameter uses the following syntax: `"LocationtType:App1,LocationType:App2,...LocationType:AppN` where LocationType is User or Group. For example, `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:Yammer"`. +- **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[] @@ -339,6 +400,30 @@ 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: @@ -376,6 +461,26 @@ 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: diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md index 4bdfa0f1e0..a6b2925a84 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Set-appretentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule applicable: Security & Compliance title: Set-AppRetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-AppRetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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-AppRetentionComplianceRule to modify app retention compliance 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 @@ -38,7 +38,7 @@ Set-AppRetentionComplianceRule [-Identity] ``` ## 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://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 @@ -111,7 +111,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). ```yaml Type: PswsHashtable[] @@ -161,7 +161,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 @@ -188,7 +188,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"`. diff --git a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md index ff92093f0a..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 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 b95a28fce2..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,14 +20,13 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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] ] [-AllowSafeDocsOpen ] - [-BlockUrls ] [-Confirm] [-EnableATPForSPOTeamsODB ] [-EnableSafeDocs ] @@ -36,13 +35,13 @@ Set-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 @@ -62,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 @@ -92,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. @@ -124,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 @@ -136,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 @@ -158,7 +135,7 @@ The EnableSafeDocs parameter enables or disables Safe Documents in organizations - $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. -For more information about Safe Documents, see [Safe Documents in Microsoft 365 A5 or E5 Security](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs) +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 @@ -180,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 diff --git a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md index 834f1bee7f..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 diff --git a/exchange/exchange-ps/exchange/Set-AuditConfig.md b/exchange/exchange-ps/exchange/Set-AuditConfig.md index 58aa915f7e..e2c5d20cfd 100644 --- a/exchange/exchange-ps/exchange/Set-AuditConfig.md +++ b/exchange/exchange-ps/exchange/Set-AuditConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-auditconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-auditconfig applicable: Security & Compliance title: Set-AuditConfig schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-AuditConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 - -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 - -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 - -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 - -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-AuthConfig.md b/exchange/exchange-ps/exchange/Set-AuthConfig.md index 6d9eadbb96..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. diff --git a/exchange/exchange-ps/exchange/Set-AuthRedirect.md b/exchange/exchange-ps/exchange/Set-AuthRedirect.md index e53e0bdb02..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,7 +30,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Set-AuthServer.md b/exchange/exchange-ps/exchange/Set-AuthServer.md index 8abd7300cc..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. @@ -154,9 +185,9 @@ Accept wildcard characters: False ### -DomainName 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 usess the syntax: "tenantname.onmicrosoft.com". +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. +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 diff --git a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md index 0360aff329..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Set-AuthenticationPolicy [-Identity] [-AllowBasicAuthRpc] [-AllowBasicAuthSmtp] [-AllowBasicAuthWebServices] + [-AllowLegacyExchangeTokens] [-BlockLegacyAuthActiveSync] [-BlockLegacyAuthAutodiscover] [-BlockLegacyAuthImap] @@ -42,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 @@ -66,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 @@ -340,6 +358,34 @@ 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. @@ -508,6 +554,180 @@ 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 +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. @@ -527,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. diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md index 6c10f860f4..08f50e337c 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy applicable: Security & Compliance title: Set-AutoSensitivityLabelPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -33,14 +33,24 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-Comment ] [-Confirm] [-Enabled ] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] [-ExchangeSender ] [-ExchangeSenderException ] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] [-ExternalMailRightsManagementOwner ] [-Force] + [-Locations ] [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] [-OverwriteLabel ] + [-PolicyRBACScopes ] [-PolicyTemplateInfo ] [-Priority ] [-RemoveExchangeLocation ] @@ -48,6 +58,9 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-RemoveOneDriveLocationException ] [-RemoveSharePointLocation ] [-RemoveSharePointLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-SpoAipIntegrationEnabled ] [-StartSimulation ] [-WhatIf] [] @@ -76,7 +89,7 @@ Set-AutoSensitivityLabelPolicy [-Identity] ``` ## 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://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 +98,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 @@ -140,7 +153,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. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -158,7 +171,7 @@ 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: `"","",...""`. @@ -176,9 +189,9 @@ 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: `"","",...""`. @@ -196,7 +209,7 @@ 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: `"","",...""`. @@ -230,11 +243,11 @@ Accept wildcard characters: False ``` ### -AutoEnableAfter -The AutoEnableAfter parameter allows you to automatically turn on the policy after a set time period in simulation. The time period restarts whenever you modify the policy or when a simulation is triggered. +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. +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. @@ -305,6 +318,79 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExchangeSender 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. @@ -447,6 +533,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mode The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: @@ -469,6 +571,79 @@ 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: @@ -490,8 +665,26 @@ 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 -{{ Fill PolicyTemplateInfo Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable @@ -551,7 +744,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. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -569,7 +762,7 @@ 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: `"","",...""`. @@ -587,7 +780,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. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -605,7 +798,7 @@ 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: `"","",...""`. @@ -623,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. @@ -642,10 +835,61 @@ 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. +- $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 @@ -653,6 +897,7 @@ Type: Boolean Parameter Sets: Identity Aliases: Applicable: Security & Compliance + Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md index 00f6d6b6ce..f477c1b30d 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule applicable: Security & Compliance title: Set-AutoSensitivityLabelRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -30,16 +30,25 @@ Set-AutoSensitivityLabelRule [-Identity] [-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 ] @@ -67,6 +76,7 @@ Set-AutoSensitivityLabelRule [-Identity] [-SenderIPRanges ] [-SentTo ] [-SentToMemberOf ] + [-SourceType ] [-SubjectMatchesPatterns ] [-WhatIf] [-Workload ] @@ -74,7 +84,7 @@ Set-AutoSensitivityLabelRule [-Identity] ``` ## 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://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 @@ -151,7 +161,7 @@ The AnyOfRecipientAddressContainsWords parameter specifies a condition for the a - 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 auto-labeling policies that are scoped only to Exchange. @@ -228,6 +238,10 @@ 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) @@ -257,6 +271,40 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Disabled The Disabled parameter specifies whether the case hold rule is enabled or disabled. Valid values are: @@ -276,8 +324,24 @@ 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 +``` + ### -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. @@ -314,6 +378,55 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfAccessScope The ExceptIfAccessScopeAccessScope parameter specifies an exception for the auto-labeling policy 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: @@ -342,7 +455,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 auto-labeling policies that are scoped only to Exchange. @@ -413,8 +526,42 @@ 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 +Default value: None +Accept pipeline input: False +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. @@ -451,6 +598,56 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfFrom The ExceptIfFrom parameter specifies an exception for the auto-labeling policy rule that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: @@ -574,7 +771,7 @@ 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 @@ -840,7 +1037,7 @@ 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 @@ -983,6 +1180,22 @@ 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"`. diff --git a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md index 5920215850..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 diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md index 68e1eb7ada..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) diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md index fd2b4c72d6..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 diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index 0faa8cc92e..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 @@ -80,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 @@ -203,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 @@ -338,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: @@ -502,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 @@ -512,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 ``` @@ -567,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 @@ -836,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 @@ -935,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 @@ -1002,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 @@ -1155,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 diff --git a/exchange/exchange-ps/exchange/set-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md similarity index 81% rename from exchange/exchange-ps/exchange/set-CASMailboxPlan.md rename to exchange/exchange-ps/exchange/Set-CASMailboxPlan.md index efa070c227..5901e16225 100644 --- a/exchange/exchange-ps/exchange/set-CASMailboxPlan.md +++ b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan +online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan applicable: Exchange Online, Exchange Online Protection title: Set-CASMailboxPlan schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,11 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-CASMailboxPlan [-Identity] [-ActiveSyncEnabled ] [-Confirm] + [-ECPEnabled ] + [-EwsEnabled ] [-ImapEnabled ] + [-MAPIEnabled ] + [-OWAEnabled ] [-OwaMailboxPolicy ] [-PopEnabled ] [-WhatIf] @@ -34,7 +38,7 @@ Set-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 @@ -107,6 +111,38 @@ 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: @@ -126,6 +162,38 @@ 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: diff --git a/exchange/exchange-ps/exchange/Set-CalendarNotification.md b/exchange/exchange-ps/exchange/Set-CalendarNotification.md index 9bdd21f491..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 diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md index 3e03be7ff0..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 @@ -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. @@ -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: diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md index 4717d9cdda..db1f2c2ede 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-caseholdpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdpolicy applicable: Security & Compliance title: Set-CaseHoldPolicy schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Set-CaseHoldPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,12 @@ Set-CaseHoldPolicy [-Identity] [-RemoveExchangeLocation ] [-RemovePublicFolderLocation ] [-RemoveSharePointLocation ] - [-UpdateStatistics] [-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://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 $_}`. @@ -63,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. @@ -90,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. @@ -119,7 +119,7 @@ To specify a mailbox or distribution group, you can use the following values: - Name - SMTP address. To specify an inactive mailbox, precede the address with a period (.). -- Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) +- 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"`. @@ -153,11 +153,11 @@ 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 @@ -254,7 +254,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Name - SMTP address. To specify an inactive mailbox, precede the address with a period (.). -- Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) +- 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"`. @@ -288,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"`. @@ -305,22 +305,6 @@ 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 - -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. diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md index d569553a8a..3935336a80 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-caseholdrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdrule applicable: Security & Compliance title: Set-CaseHoldRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 +102,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 diff --git a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md index f579227364..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 @@ -18,7 +18,7 @@ Use the Set-ClassificationRuleCollection cmdlet to update existing classificatio 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,7 +31,7 @@ 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 @@ -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) diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md b/exchange/exchange-ps/exchange/Set-ClientAccessArray.md index 72f2e036d7..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) diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md index 521804b148..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 +> [!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 @@ -60,7 +63,7 @@ Protocols that support authentication type filters: - POP3: BasicAuthentication and OAuthAuthentication. - RemotePowerShell: BasicAuthentication and NonBasicAuthentication. -Protcols that don't support authentication type filters: +Protocols that don't support authentication type filters: - ExchangeWebServices - OfflineAddressBook @@ -69,7 +72,7 @@ Protcols that don't support authentication type filters: - 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,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 @@ -325,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 @@ -523,7 +526,7 @@ Accept wildcard characters: False ### -UserRecipientFilter 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 based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. +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 use the following properties with this parameter: @@ -540,9 +543,9 @@ You can use the following properties with this parameter: 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://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- 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. +- 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: @@ -554,7 +557,7 @@ You can chain multiple search criteria together using the logical operators `-an - `"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://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +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 diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md index 68e03ab8ca..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[] diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessService.md b/exchange/exchange-ps/exchange/Set-ClientAccessService.md index 0c75099403..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[] diff --git a/exchange/exchange-ps/exchange/Set-Clutter.md b/exchange/exchange-ps/exchange/Set-Clutter.md index a1c2ba27db..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,18 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -86,6 +87,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md index 09df335b72..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 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceCase.md b/exchange/exchange-ps/exchange/Set-ComplianceCase.md index fdc1063298..2975872e51 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceCase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancecase +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancecase applicable: Security & Compliance title: Set-ComplianceCase schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md index 3309feebed..095fd20c7a 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Set-ComplianceRetentionEventType +online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype applicable: Security & Compliance title: Set-ComplianceRetentionEventType schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md index 860e7d234a..2f6e6859f5 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancesearch +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -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"`. @@ -238,7 +238,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 @@ -339,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. @@ -396,7 +396,7 @@ 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 @@ -528,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"`. @@ -566,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"`. diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md index 3c112cf3f1..a490fa06ca 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancesearchaction +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 @@ -12,11 +12,14 @@ ms.reviewer: # Set-ComplianceSearchAction ## SYNOPSIS +> [!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. diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md index 4f3f047230..5301f61588 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter +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 @@ -12,11 +12,11 @@ ms.reviewer: # Set-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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. @@ -74,7 +78,7 @@ 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 eDiscovery Premium. - Preview: The filter is applied when previewing search results. @@ -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 -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://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions#searchable-email-properties). -- 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)'"`. diff --git a/exchange/exchange-ps/exchange/Set-ComplianceTag.md b/exchange/exchange-ps/exchange/Set-ComplianceTag.md index c52b4bc93d..ef1e0e1fd7 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancetag +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancetag applicable: Security & Compliance title: Set-ComplianceTag schema: 2.0.0 @@ -12,20 +12,24 @@ ms.reviewer: # Set-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,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". @@ -85,6 +118,22 @@ 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 +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. @@ -169,6 +218,29 @@ 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 +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. @@ -227,6 +299,22 @@ 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 +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: diff --git a/exchange/exchange-ps/exchange/Set-Contact.md b/exchange/exchange-ps/exchange/Set-Contact.md index 8ea972240f..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) diff --git a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md index ae08e4cd8e..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 diff --git a/exchange/exchange-ps/exchange/Set-CustomNudge.md b/exchange/exchange-ps/exchange/Set-CustomNudge.md deleted file mode 100644 index 2ae2569afe..0000000000 --- a/exchange/exchange-ps/exchange/Set-CustomNudge.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/set-customnudge -applicable: Exchange Online -title: Set-CustomNudge -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Set-CustomNudge - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Set-CustomNudge cmdlet to modify Custom Nudges that are displayed in user Briefing email 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). - -## SYNTAX - -``` -Set-CustomNudge -Name - [-Content ] - [-From ] - [-ResultSize ] - [-Title ] - [] -``` - -## 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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Set-CustomNudge -Name perfReviewNudge -From "Microsoft HR" -Title "Please complete your performance reviews ASAP" -Content "They are very important to help your colleagues grow professionally." -``` - -This example updates an existing Custom Nudge named "perfReviewNudge" with the specified From, Title, and Content values. - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for Custom Nudge. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). - -This value is not shown to users. - -```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 -``` - -### -Content -The Content parameter specifies the text that appears below the Custom Nudge title in the Briefing email. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). - -To include hyperlinks, use the markdown format. For example, `[Contoso](https://www.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 -``` - -### -From -The From parameter specifies the creator of the Custom Nudge. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -Typically, this value is the name of the company or department that's responsible for the Custom Nudge. - -```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 -``` - -### -Title -The Title parameter specifies the bold title of the Custom Nudge that's displayed in the Briefing email. The maximum length is 128 characters. 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-CustomNudgeAssignment.md b/exchange/exchange-ps/exchange/Set-CustomNudgeAssignment.md deleted file mode 100644 index 6a796d2cb8..0000000000 --- a/exchange/exchange-ps/exchange/Set-CustomNudgeAssignment.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/set-customnudgeassignment -applicable: Exchange Online -title: Set-CustomNudgeAssignment -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Set-CustomNudgeAssignment - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Set-CustomNudgeAssignment cmdlet to modify the date range of Custom Nudge assignments. Custom Nudges are shown in the Briefing 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). - -## SYNTAX - -``` -Set-CustomNudgeAssignment -AssigneeId -NudgeName - [-EndTime ] - [-ResultSize ] - [-StartTime ] - [] -``` - -## 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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Set-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId roy@contoso.onmicrosoft.com -StartTime 2/9/2022 -EndTime 2/11/2022 -``` - -This example updates the existing Custom Nudge assignment for the specified Custom Nudge and user so the user will only see the Custom Nudge in the Briefing email between 2/9/2022 and 2/11/2022 - -## PARAMETERS - -### -AssigneeId -The AssigneeId parameter specifies the email address of the user in the Custom Nudge assignment that you want to modify. - -Together, this parameter and the AssigneeId parameter uniquely identify the Custom Nudge assignment that you want to modify. - -```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 -``` - -### -NudgeName -The NudgeName parameter specifies the name of the Custom Nudge in the Custom Nudge assignment that you want to modify. - -Together, this parameter and the NudgeName parameter uniquely identify the Custom Nudge assignment that you want to modify. - -```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 -``` - -### -EndTime -The EndTime parameter specifies the date when the Custom Nudge is no longer shown to the user. - -```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 -``` - -### -StartTime -The StartTime parameter specifies the date when the Custom Nudge is first shown to the user. - -```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/Set-CustomNudgeSettings.md b/exchange/exchange-ps/exchange/Set-CustomNudgeSettings.md deleted file mode 100644 index c34b53c5d8..0000000000 --- a/exchange/exchange-ps/exchange/Set-CustomNudgeSettings.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml -Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/set-customnudgesettings -applicable: Exchange Online -title: Set-CustomNudgeSettings -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: shusun ---- - -# Set-CustomNudgeSettings - -## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). - -**Note**: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature. - -Use the Set-CustomNudgeSettings cmdlet to modify the organization settings for Custom Nudges. Custom Nudges are shown in the Briefing 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). - -## SYNTAX - -``` -Set-CustomNudgeSettings [-Enabled ] - [-ResultSize ] - [-Title ] - [] -``` - -## 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 roles in Azure Active Directory: - -- Global Administrator -- Exchange Administrator -- Insights Administrator - -To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference). - -## EXAMPLES - -### Example 1 -```powershell -Set-CustomNudgeSettings -Enabled $true -Title "Contoso HR" -``` - -This example turns on the Custom Nudge section and Custom Nudges in all Briefing email messages. The name of the Custom Nudge section is Contoso HR. - -### Example 2 -```powershell -Set-CustomNudgeSettings -Enabled $false -``` - -This example turns off the Custom Nudge section and Custom Nudges in all Briefing email messages. - -## PARAMETERS - -### -Enabled -The Enabled parameter enables or disables Custom Nudges in all Briefing email messages. Valid values are: - -- $true: Custom Nudges and the Custom Nudge section are available. You create Custom Nudges by using the New-CustomNudge cmdlet. You assign Custom Nudges to users by using the New-CustomNudgeAssignment cmdlet. -- $false: Custom Nudges and the Custom Nudge section are not available in Briefing email 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 -``` - -### -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 -``` - -### -Title -The Title parameter specifies the title of the Custom Nudge section in the Briefing email. 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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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-DataClassification.md b/exchange/exchange-ps/exchange/Set-DataClassification.md index 28673f8997..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 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS 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 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 @@ -59,10 +59,15 @@ This example removes the existing Spanish translation from the data classificati ### Example 3 ```powershell $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 @@ -193,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. diff --git a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md index 18e0a1ecdd..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -110,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 @@ -123,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 @@ -141,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 @@ -161,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 @@ -192,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 @@ -228,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 @@ -247,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 @@ -265,7 +267,7 @@ Use this switch to delete all data that's encrypted by the data encryption polic 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 diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md index c9e4cc02f0..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 diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md index 0791ac98f2..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 bee7c87f64..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 ``` diff --git a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md b/exchange/exchange-ps/exchange/Set-DetailsTemplate.md index 9b0106ef34..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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md index 9a9b3f3b34..0bbba58e9e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy applicable: Security & Compliance title: Set-DeviceConditionalAccessPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md index a540888c07..f9e793ed4e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule applicable: Security & Compliance title: Set-DeviceConditionalAccessRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 @@ -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: @@ -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: @@ -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: diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md index 9f3ea0600e..ed19ba795f 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy applicable: Security & Compliance title: Set-DeviceConfigurationPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md index 1b4d5eaf19..3ea511f71e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule applicable: Security & Compliance title: Set-DeviceConfigurationRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConfigurationRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 @@ -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: @@ -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: @@ -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: diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md index 003a39c6ae..4642570323 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-devicetenantpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantpolicy applicable: Security & Compliance title: Set-DeviceTenantPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md index 56e899f1e1..e931196275 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-devicetenantrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantrule applicable: Security & Compliance title: Set-DeviceTenantRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceTenantRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md index 8f808cf5a9..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 @@ -89,6 +89,7 @@ Set-DistributionGroup [-Identity] [-SendOofMessageToOriginatorEnabled ] [-SimpleDisplayName ] [-UMDtmfMap ] + [-UpdateMemberCount] [-WhatIf] [-WindowsEmailAddress ] [] @@ -97,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 @@ -254,7 +255,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -314,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 @@ -683,13 +687,13 @@ Accept wildcard characters: False ### -Description This parameter is available only in the cloud-based service. -{{ Fill Description Description }} +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 +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -735,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: @@ -1000,10 +1004,12 @@ Accept wildcard characters: False ### -HiddenGroupMembershipEnabled This parameter is available only in the cloud-based service. -The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from members of the group and users who aren't members of the group. You don't need to specify a value with this switch. +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 Parameter Sets: (All) @@ -1112,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 @@ -1131,8 +1144,6 @@ To add or remove owners without affecting other existing entries, use the follow Owners that you specify with this parameter are not added as group members. You need to manually add the owner as a member. -**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 Parameter Sets: (All) @@ -1318,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. @@ -1437,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. @@ -1644,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. diff --git a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md index 57b6c5808e..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 diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md index b2b0b74c2a..ef3708c0cf 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy applicable: Security & Compliance title: Set-DlpCompliancePolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DlpCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 @@ -40,14 +40,25 @@ 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 ] @@ -65,6 +76,11 @@ Set-DlpCompliancePolicy [-Identity] [-RemoveTeamsLocationException ] [-RemoveThirdPartyAppDlpLocation ] [-RemoveThirdPartyAppDlpLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-StartSimulation ] + [-TeamsLocation ] + [-TeamsLocationException ] [-WhatIf] [] ``` @@ -78,7 +94,7 @@ Set-DlpCompliancePolicy [-Identity] [-RetryDistribution] ``` ## 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://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 $_}`. @@ -89,7 +105,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 @@ -129,7 +145,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 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 if you used this switch. @@ -149,13 +165,13 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocation -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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. 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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -171,13 +187,13 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocationException -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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: `"","",...""`. -For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -217,11 +233,11 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter adds OneDrive for Business sites to the DLP policy if they're not already included. The valid value for this parameter is All. +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 for Business 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 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 for Business sites. +- 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. @@ -233,7 +249,7 @@ If the policy doesn't already include OneDrive for Business sites (in the output 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 365 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. +**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 @@ -269,7 +285,7 @@ The AddOnPremisesScannerDlpLocation parameter specifies the on-premises file sha 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://docs.microsoft.com/microsoft-365/compliance/dlp-on-premises-scanner-learn). +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 @@ -289,7 +305,7 @@ The AddOnPremisesScannerDlpLocationExclusion parameter specifies the on-premises 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://docs.microsoft.com/microsoft-365/compliance/dlp-on-premises-scanner-learn). +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 @@ -353,9 +369,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online 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. +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. -You can't add SharePoint Online sites to the policy until they have been indexed. +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: `"","",...""`. @@ -373,9 +389,9 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException -The AddSharePointLocationException parameter specifies the SharePoint Online 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. +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 Online sites to the policy until they have been indexed. +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: `"","",...""`. @@ -429,13 +445,13 @@ Accept wildcard characters: False ``` ### -AddThirdPartyAppDlpLocation -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/dlp-use-policies-non-microsoft-cloud-apps). +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 @@ -451,13 +467,13 @@ Accept wildcard characters: False ``` ### -AddThirdPartyAppDlpLocationException -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/dlp-use-policies-non-microsoft-cloud-apps). +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 @@ -507,12 +523,80 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfOneDriveSharedBy -The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive for Business user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com). +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: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- 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: `"","",...""`. @@ -533,11 +617,11 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf -The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive for Business sites of group members are excluded from the policy). You identify the groups by 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: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- 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: `"","",...""`. @@ -559,8 +643,40 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExchangeSenderMemberOf -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. +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: `"","",...""`. @@ -587,13 +703,13 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException -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. +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: -- The policy already includes email messages (in the output of Get-DlpCOmpliancePolicy, the ExchangeLocation property value is Al). +- 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. @@ -631,13 +747,66 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mode The Mode parameter specifies the action and notification level of the DLP policy. Valid values are: - 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 @@ -652,12 +821,44 @@ 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 DLP policy (the sites of the OneDrive for Business user accounts are included in the policy). You identify the users by UPN (laura@contoso.onmicrosoft.com). +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: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- 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: `"","",...""`. @@ -678,11 +879,11 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf -The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive for Business sites of group members are included in the policy). You identify the groups by 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: -- The policy already includes OneDrive for Business sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- 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: `"","",...""`. @@ -704,8 +905,28 @@ 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 -{{ Fill PolicyTemplateInfo Description }} +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 @@ -745,13 +966,13 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocation -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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 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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -767,13 +988,13 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocationException -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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. 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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -807,11 +1028,11 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter removes OneDrive for Business sites from the DLP policy if they're already included. The valid value for this parameter is All. +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 for Business 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 for Business sites. +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. -**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 365 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. +**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 @@ -847,7 +1068,7 @@ The RemoveOnPremisesScannerDlpLocation parameter specifies the on-premises file 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://docs.microsoft.com/microsoft-365/compliance/dlp-on-premises-scanner-learn). +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 @@ -867,7 +1088,7 @@ The RemoveOnPremisesScannerDlpLocationException parameter specifies the on-premi 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://docs.microsoft.com/microsoft-365/compliance/dlp-on-premises-scanner-learn). +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 @@ -931,7 +1152,7 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online 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. +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. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -949,7 +1170,7 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException -The RemoveSharePointLocationException parameter specifies the SharePoint Online 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. +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. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -967,7 +1188,7 @@ Accept wildcard characters: False ``` ### -RemoveTeamsLocation -The AddTeamsLocation 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. +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. To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. @@ -1003,13 +1224,13 @@ Accept wildcard characters: False ``` ### -RemoveThirdPartyAppDlpLocation -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/dlp-use-policies-non-microsoft-cloud-apps). +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 @@ -1025,13 +1246,93 @@ Accept wildcard characters: False ``` ### -RemoveThirdPartyAppDlpLocationException -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/dlp-use-policies-non-microsoft-cloud-apps). +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAdaptiveScopesException +{{ Fill TeamsAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index fc84b4e29f..4a833c4d4b 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancerule applicable: Security & Compliance title: Set-DlpComplianceRule schema: 2.0.0 @@ -12,31 +12,35 @@ ms.reviewer: # Set-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 ] @@ -48,10 +52,14 @@ Set-DlpComplianceRule [-Identity] [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] @@ -68,17 +76,17 @@ Set-DlpComplianceRule [-Identity] [-ExceptIfDocumentMatchesPatterns ] [-ExceptIfDocumentNameMatchesPatterns ] [-ExceptIfDocumentNameMatchesWords ] - [-ExceptIfDocumentSizeOver ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] - [-ExceptIfFromScope ] + [-ExceptIfFromScope ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfMessageSizeOver ] - [-ExceptIfMessageTypeMatches ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientADAttributeContainsWords ] [-ExceptIfRecipientADAttributeMatchesPatterns ] @@ -94,47 +102,57 @@ 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 ] + [-NonBifurcatingAccessScope ] [-NotifyAllowOverride ] + [-NotifyEmailCustomSenderDisplayName ] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] + [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] [-NotifyUser ] + [-NotifyUserType ] [-OnPremisesScannerDlpRestrictions ] [-PrependSubject ] - [-Priority ] - [-ProcessingLimitExceeded ] + [-Priority ] [-ProcessingLimitExceeded ] [-Quarantine ] [-RecipientADAttributeContainsWords ] [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] - [-ReportSeverityLevel ] - [-RuleErrorAction ] - [-RuleErrorAction ] + [-RestrictAccess ] + [-RestrictBrowserAccess ] + [-RuleErrorAction ] [-SenderADAttributeContainsWords ] [-SenderADAttributeMatchesPatterns ] [-SenderAddressLocation ] @@ -143,19 +161,22 @@ Set-DlpComplianceRule [-Identity] [-SentTo ] [-SentToMemberOf ] [-SetHeader ] + [-SharedByIRMUserRisk ] [-StopPolicyProcessing ] [-SubjectContainsWords ] [-SubjectMatchesPatterns ] [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] + [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] [-UnscannableDocumentExtensionIs ] [-WhatIf] - [-WithImportance ] + [-WithImportance ] [] ``` ## 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://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 @@ -166,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 @@ -197,7 +287,7 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on - None: The condition isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -213,7 +303,7 @@ 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 @@ -246,6 +336,26 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AlertProperties {{ Fill AlertProperties Description }} @@ -269,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. @@ -306,6 +416,24 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplyHtmlDisclaimer The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. @@ -328,6 +456,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockAccess The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: @@ -350,12 +494,12 @@ 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 @@ -389,6 +533,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) @@ -421,11 +567,11 @@ 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: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";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[] @@ -441,7 +587,7 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -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. +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 @@ -472,6 +618,22 @@ 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 }} @@ -578,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. @@ -691,7 +853,7 @@ 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 @@ -703,6 +865,23 @@ 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 ("). @@ -721,8 +900,24 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndpointDlpRestrictions -**Note**: This parameter requires membership in the Compliance administrator or Compliance data administrator roles in Azure Active Directory. +**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"=""},...)`. @@ -740,11 +935,11 @@ 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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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[] @@ -759,6 +954,53 @@ 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 +Default value: None +Accept pipeline input: False +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: @@ -767,7 +1009,7 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP - None: The exception isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -786,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. @@ -844,11 +1086,11 @@ 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: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";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[] @@ -864,7 +1106,7 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords -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. +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 @@ -982,7 +1224,7 @@ 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: +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. @@ -1095,7 +1337,7 @@ 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 @@ -1196,7 +1438,7 @@ 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 @@ -1278,12 +1520,12 @@ When you enter a value, qualify the value with one of the following units: - GB (gigabytes) - TB (terabytes) -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +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: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -1310,7 +1552,7 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha 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 @@ -1346,33 +1588,33 @@ The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception f - 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. @@ -1396,33 +1638,33 @@ The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception - 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. @@ -1442,7 +1684,7 @@ 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 @@ -1462,33 +1704,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. @@ -1512,33 +1754,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. @@ -1716,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. @@ -1743,7 +1985,7 @@ 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 @@ -1759,7 +2001,7 @@ 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 @@ -1854,13 +2096,13 @@ 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 @@ -1990,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 @@ -1998,7 +2240,7 @@ 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[] @@ -2013,6 +2255,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. @@ -2029,7 +2287,7 @@ 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 @@ -2056,7 +2314,23 @@ The MessageTypeMatches parameter specifies a condition for the rule that looks f You can use this condition 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 + +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 @@ -2069,7 +2343,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. @@ -2087,7 +2361,15 @@ Accept wildcard characters: False ``` ### -ModifySubject -{{ Fill ModifySubject Description }} +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 @@ -2112,7 +2394,7 @@ The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule t You can use this condition in DLP policies that are scoped only to Exchange ```yaml -Type: NonBifurcatingAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2128,6 +2410,7 @@ Accept wildcard characters: False 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. @@ -2146,6 +2429,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -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. @@ -2168,7 +2467,7 @@ 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. @@ -2185,12 +2484,44 @@ 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 Azure Active Directory. +**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://docs.microsoft.com/microsoft-365/compliance/endpoint-dlp-learn-about). +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 @@ -2205,6 +2536,38 @@ 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 + +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. @@ -2222,9 +2585,9 @@ 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`. +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://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +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:คำแนะนำนโยบายในไทย"`. @@ -2241,6 +2604,41 @@ 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: @@ -2264,6 +2662,27 @@ 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 }} @@ -2281,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. @@ -2309,10 +2728,10 @@ 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 @@ -2369,33 +2788,33 @@ The RecipientADAttributeContainsWords parameter specifies a condition for the DL - 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. @@ -2419,35 +2838,35 @@ The RecipientADAttributeMatchesPatterns parameter specifies a condition for the - 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. @@ -2464,8 +2883,25 @@ 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 @@ -2501,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. @@ -2560,15 +2996,47 @@ 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 +Default value: None +Accept pipeline input: False +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: PolicyRuleErrorAction +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -2585,33 +3053,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. @@ -2635,35 +3103,35 @@ 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. @@ -2687,7 +3155,7 @@ The SenderAddressLocation parameter specifies where to look for sender addresses - 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: +Note that message envelope searching is available only for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords @@ -2804,6 +3272,28 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopPolicyProcessing The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: @@ -2905,8 +3395,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThirdPartyAppDlpRestrictions +{{ Fill ThirdPartyAppDlpRestrictions 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 +``` + +### -TriggerPowerAutomateFlow +{{ Fill TriggerPowerAutomateFlow 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 +``` + ### -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. @@ -2949,7 +3471,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md index c001d898ed..be8d02a43c 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Set-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema applicable: Security & Compliance title: Set-DlpEdmSchema schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,9 +28,9 @@ 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md index 009902751c..aa9f4a5616 100644 --- a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary applicable: Security & Compliance title: Set-DlpKeywordDictionary schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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) + 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) + 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) + 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) + Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywords ``` @@ -137,6 +157,22 @@ 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 +Default value: None +Accept pipeline input: False +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. diff --git a/exchange/exchange-ps/exchange/Set-DlpPolicy.md b/exchange/exchange-ps/exchange/Set-DlpPolicy.md index a0b2e06136..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 @@ -102,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 diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md index d2c1650568..e6a09ab1b6 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype applicable: Security & Compliance title: Set-DlpSensitiveInformationType 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-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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,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) diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md index b08bc81350..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 @@ -103,6 +103,7 @@ Set-DynamicDistributionGroup [-Identity] [-SendOofMessageToOriginatorEnabled ] [-SimpleDisplayName ] [-UMDtmfMap ] + [-UpdateMemberCount] [-WhatIf] [-WindowsEmailAddress ] [] @@ -117,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 @@ -132,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 @@ -280,7 +280,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -1097,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: @@ -1157,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". @@ -1299,7 +1298,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1639,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 @@ -1667,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. @@ -1710,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). +- 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://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- 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 @@ -1989,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. @@ -2017,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 diff --git a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md deleted file mode 100644 index a86ad7f0d6..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md +++ /dev/null @@ -1,185 +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 maximum length 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 Azure AD 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 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 592105e8b3..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPGroup.md +++ /dev/null @@ -1,140 +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 9b9cb9ad69..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPMailUser.md +++ /dev/null @@ -1,191 +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 maximum length 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 Azure AD 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 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 index 92fe89adf0..2f487200f3 100644 --- a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eopprotectionpolicyrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-eopprotectionpolicyrule applicable: Exchange Online, Exchange Online Protection title: Set-EOPProtectionPolicyRule schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,12 +37,12 @@ Set-EOPProtectionPolicyRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell). +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 or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Profiles in preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policiesprofiles-in-preset-security-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ 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[] @@ -226,7 +226,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[] diff --git a/exchange/exchange-ps/exchange/Set-EOPUser.md b/exchange/exchange-ps/exchange/Set-EOPUser.md deleted file mode 100644 index 4482740d8c..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPUser.md +++ /dev/null @@ -1,420 +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 c6414ddad5..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. diff --git a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md index 9a365b7fde..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 diff --git a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md index 69d7b85530..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. @@ -643,7 +643,7 @@ Accept wildcard characters: False ### -EnabledPrimarySMTPAddressTemplate 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. @@ -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). +- 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 diff --git a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md b/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md index 9bac9e58e3..795f69bb1f 100644 --- a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md +++ b/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-emailtenantsettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-emailtenantsettings applicable: Exchange Online title: Set-EmailTenantSettings schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## 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://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 +147,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/exchange/exchange-ps/exchange/Set-EventLogLevel.md b/exchange/exchange-ps/exchange/Set-EventLogLevel.md index f94ec6bc2c..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 diff --git a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md index 05d6e20ef0..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 diff --git a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md index c286c93752..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 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 1b58bcb280..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 @@ -34,6 +34,7 @@ Set-ExchangeServer [-Identity] [-MitigationsEnabled ] [-MonitoringGroup ] [-ProductKey ] + [-RingLevel ] [-StaticConfigDomainController ] [-StaticDomainControllers ] [-StaticExcludedDomainControllers ] @@ -45,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 @@ -259,7 +260,7 @@ The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitiga - $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://docs.microsoft.com/exchange/exchange-emergency-mitigation-service). +For more information, see [Exchange Emergency Mitigation (EM) service](https://learn.microsoft.com/exchange/exchange-emergency-mitigation-service). ```yaml Type: Boolean @@ -306,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). diff --git a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md index f7e713a6ed..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) @@ -750,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). +- 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. diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md similarity index 65% rename from exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md rename to exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md index b71e358bdc..2b5d969329 100644 --- a/exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md +++ b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md @@ -1,53 +1,59 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-phishsimoverriderule -applicable: Security & Compliance -title: Set-PhishSimOverrideRule +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-PhishSimOverrideRule +# Set-ExoPhishSimOverrideRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -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). +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-PhishSimOverrideRule [-Identity] +Set-ExoPhishSimOverrideRule [-Identity] [-AddDomains ] - [-AddSenderDomainIs ] [-AddSenderIpRanges ] [-Comment ] [-Confirm] + [-DomainController ] [-RemoveDomains ] - [-RemoveSenderDomainIs ] [-RemoveSenderIpRanges ] [-WhatIf] [] ``` ## DESCRIPTION -A phishing simulation requires at least one domain and at least one IP address. - -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 -Set-PhishSimOverrideRule -Identity PhishSimOverrideRulea0eae53e-d755-4a42-9320-b9c6b55c5011 -AddDomains blueyonderairlines.com -RemoveSenderIpRanges 192.168.1.55 +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 @@ -58,14 +64,16 @@ The Identity parameter specifies the phishing simulation override rule that you - 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: Security & Compliance +Applicable: Exchange Online Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False @@ -80,23 +88,7 @@ You can specify multiple values separated by commas. A maximum of 20 entries are Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddSenderDomainIs -This parameter has been replaced by the AddDomains parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -120,7 +112,7 @@ A maximum of 10 entries are allowed in the list. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -136,7 +128,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -155,7 +147,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -164,16 +156,14 @@ 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. +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: MultiValuedProperty +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -182,14 +172,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveSenderDomainIs -This parameter has been replaced by the RemoveDomains parameter. +### -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: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -211,7 +203,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -221,13 +213,13 @@ Accept wildcard characters: False ``` ### -WhatIf -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. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -237,7 +229,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md similarity index 52% rename from exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md index 7d70c44bd8..b20f1787e3 100644 --- a/exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md +++ b/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md @@ -1,46 +1,54 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-secopsoverriderule -applicable: Security & Compliance -title: Set-SecOpsOverrideRule +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-SecOpsOverrideRule +# Set-ExoSecOpsOverrideRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -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). +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). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**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-SecOpsOverrideRule [-Identity] - [-AddSentTo ] +Set-ExoSecOpsOverrideRule [-Identity] [-Comment ] [-Confirm] - [-RemoveSentTo ] + [-DomainController ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 -Set-SecOpsOverrideRule -Identity SecOpsOverrideRule6fed4b63-3563-495d-a481-b24a311f8329 -RemoveSentTo sceops2@contoso.com +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 modifies the SecOps mailbox override rule with the specified settings. +This example adds a comment to the specified SecOps mailbox override rule. ## PARAMETERS @@ -52,37 +60,21 @@ The Identity parameter specifies the SecOps override rule that you want to modif - 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: Security & Compliance +Applicable: Exchange Online Required: True -Position: 0 +Position: 1 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 - -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". @@ -90,7 +82,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -109,7 +101,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -118,16 +110,14 @@ 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. +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: MultiValuedProperty +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -137,13 +127,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance PowerShell. +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md b/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md index 83686438bb..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -58,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 @@ -131,4 +135,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-OrganizationConfig](https://docs.microsoft.com/powershell/module/exchange/set-organizationconfig) +[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 a5dd12219c..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 diff --git a/exchange/exchange-ps/exchange/Set-FederationTrust.md b/exchange/exchange-ps/exchange/Set-FederationTrust.md index 35b2819d9e..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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md index 3f88bdc978..2c6319179c 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertyauthority +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md index 4d873a7094..c997f07927 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertycategory +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md index 64b408e454..78ebda0733 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md index 8cab61a6d8..40d312c5a8 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertydepartment +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 PowerShell. For more information, see [Security & Compliance 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 @@ -30,7 +30,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned 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 diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md index b7f033ed1d..0be4986969 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertyreferenceid +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyreferenceid applicable: Security & Compliance title: Set-FilePlanPropertyReferenceId schema: 2.0.0 @@ -9,11 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertyReferenceId ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md index a6b8bf12a8..384fa72ff4 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertysubcategory +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 PowerShell. For more information, see [Security & Compliance 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 diff --git a/exchange/exchange-ps/exchange/Set-FocusedInbox.md b/exchange/exchange-ps/exchange/Set-FocusedInbox.md index 0e0420d3bd..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,20 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ -88,6 +89,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Set-ForeignConnector.md b/exchange/exchange-ps/exchange/Set-ForeignConnector.md index c919420085..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 diff --git a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md b/exchange/exchange-ps/exchange/Set-FrontendTransportService.md index 30ca56c588..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 diff --git a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md index 19a04a5094..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 @@ -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). +- 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 diff --git a/exchange/exchange-ps/exchange/Set-Group.md b/exchange/exchange-ps/exchange/Set-Group.md index 6c7c39ce05..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 @@ -44,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 @@ -138,7 +138,7 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md index a9b3ec5620..d1f0720b66 100644 --- a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy applicable: Security & Compliance title: Set-HoldCompliancePolicy schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Set-HoldCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,7 @@ Set-HoldCompliancePolicy [-Identity] ``` ## 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://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 $_}`. @@ -63,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. @@ -90,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. @@ -154,11 +154,11 @@ 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 @@ -290,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"`. diff --git a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md index 5c630f28bd..e86f4d51b9 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancerule applicable: Security & Compliance title: Set-HoldComplianceRule schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Set-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -108,7 +108,7 @@ 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 @@ -126,7 +126,7 @@ 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 @@ -144,7 +144,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 diff --git a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md index 0336821381..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-HostedConnectionFilterPolicy [-Identity] [-IncreaseScoreWithNumericIps ] [-IncreaseScoreWithRedirectToOtherPort ] [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] [-LanguageBlockList ] [-MakeDefault] [-MarkAsSpamBulkMail ] @@ -68,7 +69,7 @@ Set-HostedContentFilterPolicy [-Identity] [-ModifySubjectValue ] [-PhishQuarantineTag ] [-PhishSpamAction ] - [-PhishZapEnabled + [-PhishZapEnabled ] [-QuarantineRetentionPeriod ] [-RedirectToRecipients ] [-RegionBlockList ] @@ -82,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 @@ -168,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"`. @@ -190,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"`. @@ -212,7 +213,7 @@ 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 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"`. @@ -234,7 +235,7 @@ 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 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"`. @@ -260,7 +261,11 @@ The BulkQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -281,9 +286,9 @@ The BulkSpamAction parameter specifies the action to take on messages that are m - 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 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 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. +- 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 @@ -302,7 +307,7 @@ Accept wildcard characters: False ### -BulkThreshold 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 @@ -337,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 @@ -358,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 @@ -415,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 @@ -431,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 @@ -447,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 @@ -465,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) @@ -483,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 @@ -523,7 +509,6 @@ 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. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. - 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. @@ -547,7 +532,11 @@ The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy t - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -568,8 +557,8 @@ The HighConfidenceSpamAction parameter specifies the action to take on messages - 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 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 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. +- 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 @@ -592,7 +581,11 @@ The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy th - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -608,12 +601,10 @@ 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. - 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 @@ -630,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 @@ -652,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. @@ -674,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. @@ -714,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"`. @@ -779,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. @@ -801,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. @@ -823,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. @@ -845,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. @@ -867,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. @@ -888,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. @@ -910,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. @@ -931,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. @@ -953,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. @@ -975,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. @@ -996,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. @@ -1047,7 +1033,11 @@ The PhishQuarantineTag parameter specifies the quarantine policy that's used on - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -1068,8 +1058,8 @@ The PhishSpamAction parameter specifies the action to take on messages that 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. -- Quarantine: Move 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. +- 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 @@ -1187,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 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 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. +- 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 @@ -1211,7 +1201,11 @@ The SpamQuarantineTag parameter specifies the quarantine policy that's used on m - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 @@ -1248,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. @@ -1270,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. @@ -1324,4 +1314,4 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 f5bc5c047f..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Set-HostedContentFilterRule [-Identity] ## DESCRIPTION > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Use the Microsoft 365 Defender portal to create anti-spam policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies#use-the-microsoft-365-defender-portal-to-create-anti-spam-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,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[] @@ -240,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[] diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md index 8b965172b8..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md index 0190556359..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 diff --git a/exchange/exchange-ps/exchange/Set-HybridMailflow.md b/exchange/exchange-ps/exchange/Set-HybridMailflow.md deleted file mode 100644 index f8286dd8a5..0000000000 --- a/exchange/exchange-ps/exchange/Set-HybridMailflow.md +++ /dev/null @@ -1,199 +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). - -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 - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 371d895bd3..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 diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md index 6aca56605b..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 diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md index 495a11f0eb..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 diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md index daa3595f97..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 diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md index c8ace27ceb..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 diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md index 05312d6e03..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 diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md index 551dd4a0e1..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 @@ -53,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 @@ -145,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 @@ -227,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 @@ -266,6 +266,8 @@ 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. @@ -275,7 +277,7 @@ The EnablePortalTrackingLogs parameter specifies whether to turn on auditing for Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -349,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 @@ -370,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) @@ -388,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 @@ -412,7 +416,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 diff --git a/exchange/exchange-ps/exchange/Set-ImapSettings.md b/exchange/exchange-ps/exchange/Set-ImapSettings.md index 661c8d9887..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 diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md index ea87449225..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -103,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. @@ -186,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 @@ -328,11 +328,13 @@ Accept wildcard characters: False ``` ### -RequireTls -The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by the connector. Valid values are: +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 Parameter Sets: (All) @@ -347,11 +349,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate -The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the connector. Valid values are: +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 Parameter Sets: (All) @@ -366,11 +370,13 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses -The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses. Valid values are: +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. +**Note**: This parameter applies only to Partner type connectors. + ```yaml Type: Boolean Parameter Sets: (All) @@ -401,7 +407,7 @@ Accept wildcard characters: False ``` ### -SenderDomains -The SenderDomains parameter specifies the source domains that the connector accepts messages for. 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). +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. @@ -419,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 @@ -482,7 +491,11 @@ Accept wildcard characters: False ``` ### -TrustedOrganizations -{{ Fill TrustedOrganizations Description }} +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 diff --git a/exchange/exchange-ps/exchange/Set-InboxRule.md b/exchange/exchange-ps/exchange/Set-InboxRule.md index a7102a6d6b..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 @@ -99,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. @@ -215,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 @@ -367,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 @@ -417,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 @@ -446,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 @@ -507,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 @@ -643,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. @@ -663,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. @@ -687,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 @@ -753,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 @@ -775,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 @@ -1025,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 @@ -1086,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 @@ -1317,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 @@ -1370,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. @@ -1390,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. @@ -1414,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 @@ -1564,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 @@ -1586,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 diff --git a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md index be90113929..2fbe4dd044 100644 --- a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy applicable: Security & Compliance title: Set-InformationBarrierPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,7 @@ Set-InformationBarrierPolicy -Identity [-SegmentsAllowed ] [-Comment ] [-Confirm] + [-ModerationAllowed ] [-Force] [-State ] [-WhatIf] @@ -39,6 +40,7 @@ Set-InformationBarrierPolicy -Identity [-Comment ] [-Confirm] [-Force] + [-ModerationAllowed ] [-State ] [-WhatIf] [] @@ -51,6 +53,7 @@ Set-InformationBarrierPolicy -Identity [-Comment ] [-Confirm] [-Force] + [-ModerationAllowed ] [-State ] [-WhatIf] [] @@ -59,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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -147,6 +150,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SegmentsAllowed The SegmentsAllowed parameter specifies the segments that are allowed to communicate with the segment in this policy (users defined by the AssignedSegment parameter). Only these specified segments can communicate with the segment in this policy. @@ -250,6 +269,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 3bc5d8ec90..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 diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index 4304efc091..8424874e92 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label +online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label applicable: Security & Compliance title: Set-Label schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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,7 @@ Set-Label [-Identity] [-NextLabel ] [-ParentId ] [-PreviousLabel ] - [-Priority ] + [-Priority ] [-SchematizedDataCondition ] [-Setting ] [-Settings ] @@ -78,13 +81,30 @@ Set-Label [-Identity] [-SiteAndGroupProtectionLevel ] [-SiteAndGroupProtectionPrivacy ] [-SiteExternalSharingControlType ] + [-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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -127,23 +147,31 @@ Accept wildcard characters: False ### -AdvancedSettings 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://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 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. -Many 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 and services that support built-in labeling. For a list of these and 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: -- **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://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-default-sharing-link). +- **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). -- **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://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-default-sharing-link). +- **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). -- **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://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-teams-groups-sites#configure-site-sharing-permissions-by-using-powershell-advanced-settings). +- **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). -- **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](/microsoft-365/compliance/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](/microsoft-365/compliance/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). +- **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). -For more information to help you configure advanced settings for a label, see [PowerShell tips for specifying the advanced settings](/microsoft-365/compliance/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings). +- **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 @@ -187,7 +215,7 @@ 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 @@ -222,6 +250,8 @@ 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) @@ -241,7 +271,7 @@ 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 @@ -258,8 +288,10 @@ 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 @@ -318,7 +350,7 @@ 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 @@ -372,7 +404,7 @@ 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 @@ -389,8 +421,10 @@ 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 @@ -420,6 +454,29 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplyWaterMarkingEnabled The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are: @@ -427,7 +484,7 @@ 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 @@ -481,7 +538,7 @@ 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 @@ -494,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 @@ -565,7 +622,7 @@ 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 @@ -600,13 +657,17 @@ 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 @@ -621,6 +682,22 @@ 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 +``` + ### -DisplayName The DisplayName parameter specifies the display name for the sensitivity label. The display name appears in any client that supports sensitivity labels. This includes Word, Excel, PowerPoint, Outlook, SharePoint, Teams, and Power BI. @@ -637,6 +714,31 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EncryptionContentExpiredOnDateInDaysOrNever The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are: @@ -667,7 +769,7 @@ 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 @@ -702,7 +804,7 @@ The EncryptionEnabled parameter specifies whether encryption in enabled. Valid v - $false: Encryption is disabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -723,7 +825,7 @@ 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 @@ -741,7 +843,7 @@ 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 @@ -762,7 +864,7 @@ 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 @@ -802,7 +904,7 @@ 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 @@ -833,7 +935,7 @@ 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 @@ -941,7 +1043,7 @@ 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 @@ -1190,6 +1292,333 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -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: 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 + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tooltip The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). @@ -1232,4 +1661,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 d9c1f34881..5b190d2637 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-labelpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-labelpolicy applicable: Security & Compliance title: Set-LabelPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-LabelPolicy ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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,7 @@ Set-LabelPolicy [-Identity] ``` ## 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://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 $_ }`. @@ -363,23 +364,35 @@ 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"}`. -- **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+), and also Outlook on Windows (version 2201+). Example: `Set-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: `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). + +- **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). + +- **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://docs.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). +- **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://docs.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-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 @@ -483,6 +496,24 @@ 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 +``` + ### -PreviousLabelPolicy 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: diff --git a/exchange/exchange-ps/exchange/Set-LinkedUser.md b/exchange/exchange-ps/exchange/Set-LinkedUser.md index bececa5995..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md index 339d98ec6b..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md index f433718bc8..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -233,7 +235,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -252,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 @@ -312,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 @@ -331,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 @@ -368,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 @@ -384,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 @@ -400,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 @@ -416,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 @@ -432,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 @@ -448,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 @@ -464,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 @@ -480,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 @@ -496,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 @@ -512,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 @@ -528,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 @@ -544,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 @@ -560,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 @@ -576,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 @@ -592,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 @@ -608,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 @@ -636,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: @@ -663,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 @@ -706,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 @@ -728,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 @@ -750,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 @@ -772,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 @@ -794,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 @@ -814,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 @@ -830,7 +832,7 @@ The ForceUpgrade switch suppresses the confirmation message that appears if 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, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -865,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 @@ -884,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 @@ -933,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 @@ -954,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 @@ -978,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 @@ -1091,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 @@ -1117,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 @@ -1146,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 @@ -1167,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 @@ -1183,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 @@ -1199,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. @@ -1240,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 @@ -1273,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 @@ -1308,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 @@ -1367,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 @@ -1377,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 @@ -1423,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 @@ -1445,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 @@ -1497,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 @@ -1516,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 @@ -1532,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 @@ -1553,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 diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md index eb8110aaae..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 @@ -244,7 +244,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -342,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 @@ -690,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: @@ -1215,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. @@ -1441,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. @@ -1465,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 diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index 227dc8db1a..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 ] @@ -672,8 +679,10 @@ Set-MailUser [-Identity] [-RemoveDisabledArchive] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailboxRegion ] [-MailTip ] @@ -707,7 +716,7 @@ Set-MailUser [-Identity] [-RemoveDisabledArchive] ### RemoveLitigationHoldEnabled ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveLitigationHoldEnabled] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -745,8 +754,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -763,7 +774,6 @@ Set-MailUser [-Identity] [-RejectMessagesFrom ] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] - [-RemoveLitigationHoldEnabled] [-RemoveMailboxProvisioningConstraint] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] @@ -783,7 +793,7 @@ Set-MailUser [-Identity] ### RemoveOrphanedHolds ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveOrphanedHolds ] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -821,8 +831,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -840,7 +852,6 @@ Set-MailUser [-Identity] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] [-RemoveMailboxProvisioningConstraint] - [-RemoveOrphanedHolds ] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] [-SecondaryAddress ] @@ -857,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 @@ -1001,7 +1087,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -1065,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 @@ -1416,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, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online @@ -1462,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: @@ -1530,7 +1616,7 @@ This feature is not available in hybrid tenants. Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -1558,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 @@ -1582,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 @@ -1809,6 +1901,24 @@ 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. @@ -1857,9 +1967,27 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SmtpAddress -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, 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 @@ -1901,7 +2029,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -1958,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: @@ -1979,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 @@ -1989,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: @@ -2010,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 @@ -2077,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, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -2163,7 +2287,7 @@ The Password parameter allows users to change their own password. You can use th - 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-AzureADUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see [Connect to Microsoft 365 with PowerShell](https://docs.microsoft.com/microsoft-365/enterprise/connect-to-microsoft-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 @@ -2185,7 +2309,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, 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. @@ -2193,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 @@ -2211,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 @@ -2416,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 @@ -2434,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 @@ -2452,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 @@ -2464,13 +2588,13 @@ Accept wildcard characters: False ### -RemoveDisabledArchive This parameter is available only in the cloud-based service. -{{ Fill RemoveDisabledArchive 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: RemoveDisabledArchive Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2482,13 +2606,15 @@ Accept wildcard characters: False ### -RemoveLitigationHoldEnabled This parameter is available only in the cloud-based service. -{{ Fill RemoveLitigationHoldEnabled 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: RemoveLitigationHoldEnabled Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2504,29 +2630,9 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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. - -```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 @@ -2544,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 @@ -2620,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 ForceChangePasswordNextLogin parameter on the Set-AzureADUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see [Connect to Microsoft 365 with PowerShell](https://docs.microsoft.com/microsoft-365/enterprise/connect-to-microsoft-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 @@ -2654,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 @@ -2779,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: @@ -2821,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 @@ -2855,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 diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 6499d68755..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 ] @@ -296,8 +297,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -360,6 +359,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -383,6 +383,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -418,7 +419,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -428,8 +428,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -492,6 +490,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -515,6 +514,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -550,7 +550,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -560,8 +559,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -624,6 +621,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -647,6 +645,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -682,7 +681,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -692,8 +690,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -755,6 +751,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-CreateDTMFMap ] [-CustomAttribute1 ] [-CustomAttribute10 ] @@ -777,6 +774,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -812,7 +810,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] [-ModeratedBy ] @@ -821,8 +818,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -885,6 +880,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -908,6 +904,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -943,7 +940,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] [-ModeratedBy ] @@ -952,8 +948,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -1016,6 +1010,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -1033,12 +1028,13 @@ Set-Mailbox [-Identity] [-CustomAttribute7 ] [-CustomAttribute8 ] [-CustomAttribute9 ] - [-DataEncryptionPolicy + [-DataEncryptionPolicy ] [-DefaultAuditSet ] [-DefaultPublicFolderMailbox ] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -1083,8 +1079,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -1129,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 @@ -1164,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 ``` @@ -1172,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 ``` @@ -1189,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 @@ -1211,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 @@ -1333,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 @@ -1349,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 @@ -1370,7 +1366,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -1741,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 @@ -1964,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. @@ -1994,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 @@ -2321,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 @@ -2519,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: @@ -2529,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: @@ -2578,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 @@ -2607,7 +2641,7 @@ The EndDateForRetentionHold parameter specifies the end date for retention hold **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". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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 @@ -2651,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 @@ -2673,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 @@ -3088,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 @@ -3149,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. @@ -3201,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 @@ -3317,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"`. @@ -3341,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 @@ -3424,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 @@ -3447,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 @@ -3463,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 @@ -3473,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. @@ -3495,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. @@ -3523,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 @@ -3800,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 @@ -3961,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) @@ -4007,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 @@ -4137,10 +4158,10 @@ 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. To change another user's password, use the Set-AzureADUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see [Connect to Microsoft 365 with PowerShell](https://docs.microsoft.com/microsoft-365/enterprise/connect-to-microsoft-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. +- 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. You can use the following methods as a value for this parameter: @@ -4161,48 +4182,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PitrCopyIntervalInSeconds -This parameter is available only in the cloud-based service. - -{{ Fill PitrCopyIntervalInSeconds Description }} - -```yaml -Type: Int16 -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 -``` - -### -PitrEnabled -This parameter is available only in the cloud-based service. - -{{ Fill PitrEnabled 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 -``` - ### -PrimarySmtpAddress 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. @@ -4368,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 @@ -4382,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 @@ -4592,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 @@ -4610,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 @@ -4658,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 @@ -4698,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 @@ -4838,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. @@ -4871,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 @@ -4899,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 @@ -4911,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. @@ -4962,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 @@ -4980,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 @@ -4996,7 +4981,17 @@ 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. + +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: @@ -5004,6 +4999,8 @@ You can use the following methods as a value for this parameter: - 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 Parameter Sets: (All) @@ -5087,7 +5084,7 @@ 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. @@ -5175,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 @@ -5253,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 @@ -5353,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 @@ -5392,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. @@ -5416,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 @@ -5493,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 @@ -5586,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 @@ -5711,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md index 86319b71a4..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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md index 913c624ae0..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 @@ -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 @@ -186,7 +186,7 @@ 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. @@ -211,7 +211,10 @@ 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. @@ -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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index 4b6ccbdae9..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,16 +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] - [-AddOnlineMeetingToAllEvents ] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] [-CalendarFeedsPreferredLanguage ] [-CalendarFeedsPreferredRegion ] [-CalendarFeedsRootPageId ] @@ -34,27 +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 ] @@ -64,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 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 @@ -114,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 @@ -125,16 +211,14 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -AddOnlineMeetingToAllEvents -This parameter is available only in the cloud-based service. - -{{ Fill AddOnlineMeetingToAllEvents Description }} +### -AgendaMailEnabled +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -143,14 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgendaMailEnabled -This parameter is reserved for internal Microsoft use. +### -AgendaMailIntroductionEnabled +This parameter is available only in the cloud-based service. + +{{ Fill AgendaMailIntroductionEnabled Description }} ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online Required: False Position: Named @@ -159,14 +245,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgendaMailIntroductionEnabled +### -AgendaPaneEnabled This parameter is available only in the cloud-based service. -{{ Fill AgendaMailIntroductionEnabled Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -177,14 +263,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgendaPaneEnabled +### -AutoDeclineWhenBusy This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +{{ Fill AutoDeclineWhenBusy Description }} ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -202,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 @@ -222,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 @@ -240,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 @@ -261,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 @@ -299,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 @@ -341,6 +427,43 @@ Default value: None 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. @@ -365,7 +488,7 @@ The DefaultOnlineMeetingProvider parameter specifies the default provider for on ```yaml Type: OnlineMeetingProviderType -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -377,7 +500,7 @@ 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. @@ -415,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. @@ -427,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 @@ -445,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 @@ -468,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 @@ -498,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 @@ -509,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 ``` @@ -567,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 @@ -588,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 @@ -599,6 +740,46 @@ 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. @@ -614,7 +795,7 @@ Setting this parameter enables the display of the **Add online meeting to all me ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -637,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 @@ -702,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 @@ -720,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 @@ -804,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. @@ -839,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 @@ -859,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 @@ -887,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 @@ -909,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 @@ -920,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. @@ -927,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 @@ -1035,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index 3b006d4429..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. @@ -290,13 +289,14 @@ The SharedCalendarSyncStartDate parameter specifies the limit for past events in 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 calender's mailbox, not the delegate's mailbox. +- 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 @@ -336,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md index 1aefa0e445..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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md index c4fab6dd46..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. diff --git a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md index ffd012fc39..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 @@ -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 @@ -305,10 +314,10 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 index a1ea8b4fbc..aab760df38 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md +++ b/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxirmaccess +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxirmaccess applicable: Exchange Online title: Set-MailboxIRMAccess schema: 2.0.0 @@ -16,7 +16,7 @@ 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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Set-MailboxIRMAccess -AccessLevel [-Identity] [!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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 @@ 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://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +**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: diff --git a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md index 30d0194083..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. diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index 6fcd61a781..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 ] @@ -48,9 +48,9 @@ This cmdlet controls the following junk email settings on the mailbox: - 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 @@ -98,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 @@ -137,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 @@ -218,6 +218,24 @@ 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 PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. @@ -239,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: @@ -287,7 +323,7 @@ To empty the list of email addresses and domains, use the value $null. - 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 @@ -309,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md index 98616873ce..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 @@ -37,6 +37,9 @@ Set-MailboxMessageConfiguration [-Identity] [-DefaultFontName ] [-DefaultFontSize ] [-DefaultFormat ] + [-DefaultSignature ] + [-DefaultSignatureOnReply ] + [-DeleteSignatureName ] [-DisplayDensityMode ] [-DomainController ] [-EchoGroupMessageBackToSubscribedSender ] @@ -73,6 +76,8 @@ Set-MailboxMessageConfiguration [-Identity] [-ShowSenderOnTopInListView ] [-ShowUpNext ] [-SignatureHtml ] + [-SignatureHtmlBody ] + [-SignatureName ] [-SignatureText ] [-SignatureTextOnMobile ] [-SigningCertificateId ] @@ -86,9 +91,9 @@ Set-MailboxMessageConfiguration [-Identity] ``` ## 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 @@ -126,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 @@ -194,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. @@ -215,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. @@ -301,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 @@ -430,6 +439,60 @@ 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. @@ -469,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 @@ -542,6 +608,8 @@ 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 @@ -969,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 @@ -1115,7 +1183,7 @@ Accept wildcard characters: False ``` ### -SignatureHtml -**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Currently, the only way to make this parameter work again is to open a support ticket and ask to have Outlook roaming signatures disabled in your organization. +**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. @@ -1134,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. @@ -1153,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. @@ -1285,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxPlan.md b/exchange/exchange-ps/exchange/Set-MailboxPlan.md index f7ac77bd6a..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -71,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 @@ -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: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -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. @@ -348,9 +348,11 @@ If you don't set a value for this parameter, existing mailboxes are also updated **Note**: Specifying a value for this parameter has the following potential issues: -- The specified retention policy is applied only to new mailboxes. The retention policy that's applied to existing mailboxes is not changed when you specify a different retention policy in the mailbox plan. -- Changes to which retention policy is the default are ignored on new and existing mailboxes. -- If you change the value of this parameter from a specific retention policy back to blank ($null), changes to which retention policy is the default do not affect mailboxes created when the retention policy was specified. Changes to which retention policy is the default only affect new mailboxes and any existing mailboxes that were created when no retention policy was specified. In effect, mailboxes created when the retention policy was specified in the mailbox plan are stuck using that retention policy (the RetentionPolicy parameter on the Set-Mailbox cmdlet is not available in Exchange Online). +- 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 @@ -396,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md index 42b889c588..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. @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md index 131ef4ed3a..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 @@ -60,7 +60,7 @@ Set-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 @@ -89,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 @@ -184,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 @@ -234,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. @@ -444,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/exchange/Set-MailboxSearch.md index d7166cc4d8..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 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 @@ -216,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. @@ -337,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 @@ -356,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 @@ -368,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 @@ -491,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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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. @@ -573,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. @@ -665,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md index 4e4cd536b3..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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxServer.md b/exchange/exchange-ps/exchange/Set-MailboxServer.md index 24b0e6de97..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 @@ -1011,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"`. @@ -1189,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. @@ -1870,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. diff --git a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md index 7cdb4c20ad..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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md b/exchange/exchange-ps/exchange/Set-MailboxTransportService.md index 25a0ef4abf..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 diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index da6364c51e..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 @@ -45,6 +45,7 @@ Set-MalwareFilterPolicy [-Identity] [-FileTypeAction ] [-FileTypes ] [-InternalSenderAdminAddress ] + [-IsPolicyOverrideApplied ] [-MakeDefault] [-QuarantineTag ] [-WhatIf] @@ -53,7 +54,7 @@ Set-MalwareFilterPolicy [-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,24 +72,30 @@ In on-premises Exchange, this example modifies the malware filter policy named C ### Example 2 ```powershell $FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes + $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 "dgz" and "mde" 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. @@ -119,9 +126,9 @@ 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 @@ -218,7 +225,7 @@ 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 DeleteAttachmentAndUseCustomAlert. +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. ```yaml Type: String @@ -234,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 @@ -255,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 @@ -276,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 @@ -299,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 @@ -322,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 @@ -343,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 @@ -364,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 @@ -401,10 +415,10 @@ 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 attachments are 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 attachments are 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. @@ -424,9 +438,9 @@ Accept wildcard characters: False ### -EnableExternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableExternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from external senders. Valid values are: +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. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. +- $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 @@ -445,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 @@ -464,10 +482,10 @@ 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, 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 attachments are detected in messages from internal senders, don't send administrator notifications. This is the default value. +- $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. **Note**: Admin notifications are sent only for _attachments_ that are classified as malware. @@ -487,9 +505,9 @@ Accept wildcard characters: False ### -EnableInternalSenderNotifications This parameter is available only in on-premises Exchange. -The EnableInternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from internal senders. Valid values are: +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 @@ -506,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 @@ -526,12 +544,12 @@ Accept wildcard characters: False ### -FileTypeAction This parameter is available only in the cloud-based service. -The FileTypeAction parameter specifies what's done to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (common attachment blocking). Valid values are: +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 policy by the QuarantineTag parameter. -- Reject: This is the default action. 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. +- 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 EnableFileFilter parameter is set to the value $true. +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. ```yaml Type: FileTypeFilteringAction @@ -549,17 +567,17 @@ 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, apk, app, appx, arj, bat, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, jar, 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` +`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[] @@ -575,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 @@ -592,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. @@ -613,13 +647,17 @@ Accept wildcard characters: False ### -QuarantineTag This parameter is available only in the cloud-based service. -The QuarantineTag 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: +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 based on why the message was quarantined. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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 diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md index df9b2d8020..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 @@ -40,9 +40,9 @@ Set-MalwareFilterRule [-Identity] ## DESCRIPTION > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Anti-malware policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/anti-malware-protection#anti-malware-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,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[] @@ -257,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[] diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md index 5b7d3c6e91..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 diff --git a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md index a284481254..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 diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolder.md b/exchange/exchange-ps/exchange/Set-ManagedFolder.md index 26f42d7e78..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 diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md index ce2c253e31..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 diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md index 21636855d7..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 ] @@ -93,14 +88,24 @@ Set-ManagementRoleAssignment [-Identity] [-CustomRes [] ``` +### 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 @@ -150,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. @@ -222,13 +267,13 @@ The CustomResourceScope parameter specifies the custom management scope to assoc 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 Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals). +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 +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -333,28 +378,6 @@ Accept pipeline input: False 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 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 ("). diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md index abfe37f123..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 ("). @@ -214,13 +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). +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 diff --git a/exchange/exchange-ps/exchange/Set-ManagementScope.md b/exchange/exchange-ps/exchange/Set-ManagementScope.md index 7439e9fa67..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). +- 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). +- 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. @@ -235,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). +- 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. @@ -262,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 @@ -314,5 +314,6 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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 ef7d577a56..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 @@ -140,7 +140,7 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,7 +159,7 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -181,7 +181,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,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 diff --git a/exchange/exchange-ps/exchange/Set-MessageClassification.md b/exchange/exchange-ps/exchange/Set-MessageClassification.md index 89f552b2cc..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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-MigrationBatch.md b/exchange/exchange-ps/exchange/Set-MigrationBatch.md index c0643930b1..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. @@ -139,7 +158,7 @@ The ApproveSkippedItems switch marks all of the skipped items that were discover 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). ```yaml Type: SwitchParameter @@ -197,7 +216,7 @@ 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: @@ -237,8 +256,6 @@ 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. 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`). @@ -249,7 +266,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded 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 @@ -281,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. @@ -452,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: diff --git a/exchange/exchange-ps/exchange/Set-MigrationConfig.md b/exchange/exchange-ps/exchange/Set-MigrationConfig.md index 0f5d465a4d..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 diff --git a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md index 209891acd8..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 diff --git a/exchange/exchange-ps/exchange/Set-MigrationUser.md b/exchange/exchange-ps/exchange/Set-MigrationUser.md index 049967a6db..9a4d3dc9f8 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Set-MigrationUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-migrationuser +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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -83,7 +83,7 @@ The ApproveSkippedItems switch marks all of the skipped items that were discover 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). You don't need to specify a value with this switch. @@ -125,14 +125,14 @@ 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 @@ -189,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. @@ -232,14 +232,14 @@ 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 diff --git a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md index 37a443f2c0..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,9 +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. -Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://docs.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). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -270,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 @@ -336,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 @@ -605,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 @@ -1156,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 diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/exchange/Set-MoveRequest.md index c65f50b8ed..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 diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md index 75afbd629a..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 diff --git a/exchange/exchange-ps/exchange/Set-Notification.md b/exchange/exchange-ps/exchange/Set-Notification.md index 472a0050f7..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 @@ -59,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 @@ -72,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 @@ -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 Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,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 @@ -134,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 @@ -144,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. @@ -180,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 @@ -198,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 @@ -217,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 @@ -235,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 @@ -253,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 @@ -271,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 @@ -290,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 @@ -306,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 diff --git a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md b/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md index 5e8f07db73..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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ When an email has been revoked, the recipient will get the following error when 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 diff --git a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md index 1bfc4b576a..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 diff --git a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md index 585f841de0..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 @@ -405,7 +405,7 @@ Accept wildcard characters: False ### -Schedule 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 diff --git a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md index 76ec92633b..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-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 @@ -60,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 @@ -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: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -191,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 diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 387d3a4b03..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 ] @@ -88,8 +99,11 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-FindTimeOnlineMeetingOptionDisabled ] [-FocusedInboxOn ] [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] [-IPListBlocked ] [-IsAgendaMailEnabled ] + [-IsGroupFoldersAndRulesEnabled ] + [-IsGroupMemberAllowedToEditContent ] [-LeanPopoutEnabled ] [-LinkPreviewEnabled ] [-MailTipsAllTipsEnabled ] @@ -100,6 +114,10 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-MaskClientIpInReceivedHeadersEnabled ] [-MatchSenderOrganizerProperties ] [-MessageHighlightsEnabled ] + [-MessageRecallAlertRecipientsEnabled ] + [-MessageRecallAlertRecipientsReadMessagesOnlyEnabled ] + [-MessageRecallEnabled ] + [-MessageRecallMaxRecallableAge ] [-MessageRemindersEnabled ] [-MobileAppEducationEnabled ] [-OAuth2ClientProfileEnabled ] @@ -111,18 +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 ] @@ -134,10 +156,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault ### AdfsAuthenticationParameter ``` -Set-OrganizationConfig [-AdfsAudienceUris ] - [-AdfsEncryptCertificateThumbprint ] - [-AdfsIssuer ] - [-AdfsSignCertificateThumbprints ] +Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCertificateThumbprint ] [-AdfsIssuer ] [-AdfsSignCertificateThumbprints ] [-ACLableSyncedObjectEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] @@ -194,6 +213,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] @@ -201,9 +221,9 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] + [-PublicFolderShowClientControl ] [-PublicFoldersEnabled ] [-PublicFoldersLockedForMigration ] - [-PublicFolderShowClientControl ] [-ReadTrackingEnabled ] [-RefreshSessionEnabled ] [-RemotePublicFolderMailboxes ] @@ -278,11 +298,11 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] - [-PublicFolderContentReplicationDisabled ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] @@ -304,6 +324,133 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [] ``` +### 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 @@ -313,6 +460,7 @@ Set-OrganizationConfig [-ByteEncoderTypeFor7BitCharsets ] [-Confirm] [-CustomerFeedbackEnabled ] + [-DefaultAuthenticationPolicy ] [-DistributionGroupDefaultOU ] [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] @@ -337,6 +485,7 @@ Set-OrganizationConfig [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OrganizationSummary ] [-PermanentlyDeleteDisabled ] [-PreferredInternetCodePageForShiftJis ] @@ -351,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 @@ -427,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. @@ -445,6 +616,24 @@ 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: @@ -520,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 @@ -596,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"`. @@ -615,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 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 @@ -660,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 @@ -681,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 @@ -701,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 @@ -715,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 @@ -739,7 +910,25 @@ After you enable auto-expanding archiving, additional storage space is automatic ```yaml Type: SwitchParameter -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 +``` + +### -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 @@ -750,6 +939,36 @@ 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. @@ -760,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 @@ -781,7 +1000,25 @@ The BookingsAuthEnabled parameter specifies whether to enforce authentication to ```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 @@ -802,7 +1039,7 @@ The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Book ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -825,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 @@ -846,7 +1083,7 @@ The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the att ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -867,7 +1104,97 @@ The BookingsMembershipApprovalRequired parameter enables a membership approval r ```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 +``` + +### -BookingsNamingPolicyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyEnabled 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 +``` + +### -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 @@ -888,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 @@ -909,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 @@ -930,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 @@ -951,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 @@ -995,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 @@ -1013,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 @@ -1034,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 @@ -1053,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 @@ -1070,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 @@ -1099,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 @@ -1120,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 @@ -1141,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 @@ -1155,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 @@ -1198,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 @@ -1240,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 @@ -1261,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 @@ -1321,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 @@ -1337,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 @@ -1365,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 @@ -1393,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 @@ -1407,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 @@ -1439,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 @@ -1450,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. @@ -1460,7 +1856,7 @@ The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1476,14 +1872,14 @@ 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 only available for plus addressing. +- $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://docs.microsoft.com/exchange/recipients-in-exchange-online/plus-addressing-in-exchange-online). +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 +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1589,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 @@ -1666,7 +2062,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1698,14 +2094,35 @@ 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: +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. + +The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users from upgrading their own distribution groups to Microsoft 365 Groups in an Exchange Online organization. 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. +- $true: Users can upgrade distribution groups that they own to Microsoft 365 Groups. +- $false: Users can't upgrade distribution groups that they own to Microsoft 365 Groups. This is the default value. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1716,19 +2133,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EndUserDLUpgradeFlowsDisabled +### -EndUserMailNotificationForDelayedDelicensingEnabled This parameter is available only in the cloud-based service. -The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users from upgrading their own distribution groups to Microsoft 365 Groups in an Exchange Online organization. Valid values are: +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: Users can upgrade distribution groups that they own to Microsoft 365 Groups. -- $false: Users can't upgrade distribution groups that they own to Microsoft 365 Groups. This is the default value. +- $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: ShortenEventScopeParameter +Parameter Sets: DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1760,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) @@ -1875,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 @@ -1893,7 +2316,7 @@ The ExchangeNotificationRecipients parameter specifies the recipients for Exchan ```yaml Type: MultiValuedProperty -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1918,7 +2341,7 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1934,7 +2357,7 @@ 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. @@ -1943,7 +2366,7 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1968,7 +2391,7 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1993,7 +2416,7 @@ For more information about FindTime, see [How to create a FindTime poll](https:/ ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2018,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 @@ -2074,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. @@ -2095,6 +2539,8 @@ Accept wildcard characters: False ### -IPListBlocked This parameter is available only in the cloud-based service. +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. @@ -2111,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 @@ -2127,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 @@ -2192,6 +2638,65 @@ 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. + +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: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LeanPopoutEnabled The LeanPopoutEnabled parameter specifies whether to enable faster loading of pop-out messages in Outlook on the web for Internet Explorer and Microsoft Edge. Valid values are: @@ -2205,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 @@ -2224,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 @@ -2381,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 @@ -2399,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 @@ -2435,6 +2940,76 @@ This parameter is available only in the cloud-based service. ```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 @@ -2456,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 @@ -2562,7 +3137,7 @@ The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitiga - $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://docs.microsoft.com/exchange/exchange-emergency-mitigation-service). +For more information, see [Exchange Emergency Mitigation (EM) service](https://learn.microsoft.com/exchange/exchange-emergency-mitigation-service). ```yaml Type: Boolean @@ -2589,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 @@ -2600,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: @@ -2612,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 @@ -2636,7 +3229,7 @@ If a user has already directly interacted with this setting in Outlook or Outloo ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2675,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 @@ -2701,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 @@ -2723,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 @@ -2741,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 @@ -2762,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 @@ -2780,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 @@ -2796,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. @@ -2821,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 @@ -2832,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. @@ -2943,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. @@ -2951,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 @@ -2963,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 @@ -3015,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 @@ -3031,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 @@ -3084,19 +3742,16 @@ 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. - -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=Outlook&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 @@ -3114,7 +3769,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 @@ -3130,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 @@ -3149,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 @@ -3160,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. @@ -3183,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 @@ -3246,7 +3946,7 @@ In the following scenarios, meeting update messages are not auto-processed, rega ```yaml Type: String -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3287,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 @@ -3308,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 @@ -3326,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 @@ -3345,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 diff --git a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md index 6ede1de74c..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 @@ -212,7 +212,7 @@ You can use this switch to run tasks programmatically where prompting for admini 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 @@ -233,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 @@ -255,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 @@ -278,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 @@ -297,13 +297,13 @@ The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. - RemoteInbound - RemoteOutbound -For more information, see [Cross-tenant mailbox migration](https://docs.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). +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 @@ -322,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 @@ -345,13 +345,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 more information, see [Cross-tenant mailbox migration](https://docs.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). +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 @@ -372,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 @@ -394,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 @@ -427,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 @@ -443,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 @@ -455,13 +455,13 @@ Accept wildcard characters: False ### -OAuthApplicationId This parameter is available only in the cloud-based service. -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://docs.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). +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 @@ -477,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 @@ -496,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 @@ -512,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 @@ -528,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 @@ -544,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 @@ -562,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 @@ -578,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 diff --git a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md index 13597de21d..49cf493921 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-organizationsegment +online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationsegment applicable: Security & Compliance title: Set-OrganizationSegment schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-OrganizationSegment ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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,11 +63,11 @@ 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). +- 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). @@ -96,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 5794175588..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -85,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) @@ -102,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. @@ -265,7 +267,7 @@ 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. @@ -317,10 +319,12 @@ 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 @@ -336,10 +340,12 @@ Accept wildcard characters: False ``` ### -SenderRewritingEnabled -The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewritting are rewritten for traffic to on-premises. This parameter is only effective for OnPremises connectors as Partner connectors already have SRS rewritting enabled. Valid values are: +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. -- $true: Messages are rewritten by SRS if they need to be before being 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 rewritten by SRS before being routed through the on-premises messaging system. This is the default value. +This parameter is effective only for OnPremises connectors. ```yaml Type: Boolean @@ -358,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"`. @@ -398,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 @@ -438,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 diff --git a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md index 81dfb1817e..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 diff --git a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md index 3d35f0e447..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 diff --git a/exchange/exchange-ps/exchange/Set-OutlookProvider.md b/exchange/exchange-ps/exchange/Set-OutlookProvider.md index f844154211..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"`. diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md index 6b91fcacf3..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 ] @@ -145,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 @@ -201,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: @@ -261,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: @@ -356,6 +411,24 @@ 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 functional only in on-premises Exchange. @@ -380,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: @@ -459,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. @@ -519,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: @@ -541,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 @@ -621,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. @@ -781,6 +913,24 @@ 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 functional only in on-premises Exchange. @@ -826,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 @@ -1105,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: @@ -1167,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 @@ -1206,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 @@ -1221,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: @@ -1338,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. @@ -1394,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. @@ -1412,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: @@ -1488,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 @@ -1549,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. @@ -1732,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. @@ -1834,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) @@ -1950,7 +2349,7 @@ The SMimeEnabled parameter specifies whether users can download the S/MIME contr - $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 @@ -1968,7 +2367,7 @@ Accept wildcard characters: False ### -SMimeSuppressNameChecksEnabled This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +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 @@ -2607,10 +3006,10 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 98955ae5a0..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. @@ -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 @@ -2175,7 +2175,7 @@ The SMimeEnabled parameter specifies whether users can download the S/MIME contr - $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 diff --git a/exchange/exchange-ps/exchange/Set-PartnerApplication.md b/exchange/exchange-ps/exchange/Set-PartnerApplication.md index d9c59366a2..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 @@ -16,7 +16,7 @@ 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 @@ -382,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 diff --git a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md b/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md index 2696b3de3c..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 diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md index 76ef87405f..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -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: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,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 diff --git a/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md deleted file mode 100644 index f24a54fd0e..0000000000 --- a/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md +++ /dev/null @@ -1,179 +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. - -**Note**: This cmdlet is in the process of being deprecated. Use the \*-TenantAllowBlockListSpoofItems cmdlets instead. - -Use the Set-PhishFilterPolicy cmdlet to configure the spoof intelligence policy in your 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). - -## 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 72c29c2aed..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 +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 PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 +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 +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 +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 +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 @@ -125,7 +161,7 @@ The WhatIf switch doesn't work in Security & Compliance PowerShell. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md index dcc28235d2..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,9 +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 except GeoCoordinates 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. -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**: 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,6 +39,8 @@ Set-Place [-Identity] [-IsWheelChairAccessible ] [-Label ] [-MTREnabled ] + [-ParentId ] + [-ParentType ] [-Phone ] [-PostalCode ] [-State ] @@ -48,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. @@ -158,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 @@ -249,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,14 +304,14 @@ Accept wildcard characters: False ``` ### -MTREnabled -**Note**: Currently, this parameter is informational only and results in no additional funcationality. +**Note**: Currently, this parameter is informational only and results in no additional functionality. -The MTREnabled parameter identfies 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: +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://docs.microsoft.com/microsoftteams/rooms/). +For more information about Microsoft Teams Rooms, see [Microsoft Teams Rooms](https://learn.microsoft.com/microsoftteams/rooms/). ```yaml Type: Boolean @@ -323,6 +326,49 @@ 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. diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/exchange/Set-PolicyConfig.md index 53b6da8a2d..6455c497f6 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-policyconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-policyconfig applicable: Security & Compliance title: Set-PolicyConfig schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-PolicyConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 @@ -28,12 +28,20 @@ Set-PolicyConfig [[-Identity] ] [-Confirm] [-DlpAppGroups ] [-DlpAppGroupsPsws ] + [-DlpExtensionGroups ] + [-DlpNetworkShareGroups ] + [-DlpPrinterGroups ] + [-DlpRemovableMediaGroups ] [-DocumentIsUnsupportedSeverity ] + [-EnableAdvancedRuleBuilder ] [-EnableLabelCoauth ] [-EnableSpoAipMigration ] [-EndpointDlpGlobalSettings ] [-EndpointDlpGlobalSettingsPsws ] [-ExtendTeamsDlpPoliciesToSharePointOneDrive ] + [-InformationBarrierMode ] + [-InformationBarrierPeopleSearchRestriction ] + [-IsDlpSimulationOptedIn ] [-OnPremisesWorkload ] [-ProcessingLimitExceededSeverity ] [-PurviewLabelConsent ] @@ -41,12 +49,14 @@ Set-PolicyConfig [[-Identity] ] [-RetentionForwardCrawl ] [-RuleErrorAction ] [-SenderAddressLocation ] + [-SiteGroups ] + [-SiteGroupsPsws ] [-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://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 +70,7 @@ To use this cmdlet in Security & Compliance PowerShell, you need to be assigned ## PARAMETERS ### -Identity -{{ Fill Identity Description }} +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. ```yaml Type: OrganizationIdParameter @@ -175,6 +185,70 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DocumentIsUnsupportedSeverity {{ Fill DocumentIsUnsupportedSeverity Description }} @@ -192,8 +266,34 @@ 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 +Default value: None +Accept pipeline input: False +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 @@ -209,7 +309,10 @@ 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 @@ -273,7 +376,10 @@ Accept wildcard characters: False ``` ### -ExtendTeamsDlpPoliciesToSharePointOneDrive -{{ Fill ExtendTeamsDlpPoliciesToSharePointOneDrive Description }} +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 @@ -288,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 }} @@ -411,6 +570,38 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md index cdb94d0b3e..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) diff --git a/exchange/exchange-ps/exchange/Set-PopSettings.md b/exchange/exchange-ps/exchange/Set-PopSettings.md index de4daa0592..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 diff --git a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md index 0aabaa96c7..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 @@ -40,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 diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md index 4c5ae14fa7..c1875d6ea6 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-protectionalert +online version: https://learn.microsoft.com/powershell/module/exchange/set-protectionalert applicable: Security & Compliance title: Set-ProtectionAlert schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Set-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 PowerShell, you need to be assigned 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 @@ -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 @@ -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). +- 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: @@ -314,7 +320,7 @@ 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 @@ -385,7 +391,7 @@ 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 @@ -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. @@ -458,6 +464,54 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Severity The Severity parameter specifies the severity of the detection. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-PublicFolder.md b/exchange/exchange-ps/exchange/Set-PublicFolder.md index f69453bc9c..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 diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md index 2c4adcc09f..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 diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md index a1c293a6b6..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. diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md index 25ea2ea266..124bd14378 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-quarantinepermissions +online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepermissions applicable: Exchange Online, Exchange Online Protection title: Set-QuarantinePermissions schema: 2.0.0 @@ -14,28 +14,31 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-QuarantinePermissions cmdlet to modify quarantine permissions objects that are used in quarantine tags (the New-QuarantineTag or Set-QuarantineTag cmdlets). This cmdlet only works on permissions objects that were created by the New-QuarantinePermissions cmdlet and stored in a variable that's currently available in the Windows PowerShell session. +**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. -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-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 - [-PermissionToBlockSender ] - [-PermissionToDelete ] - [-PermissionToDownload ] - [-PermissionToPreview ] - [-PermissionToRelease ] - [-PermissionToRequestRelease ] - [-PermissionToViewHeader ] + [[-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 tag permissions stored in the `$Perms` variable. +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,14 +47,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-QuarantinePermissions -QuarantinePermissionsObject $Perms -PermissionToRequestRelease $true -PermissionToRelease $false ``` -This example modifies the specified quarantine tag permissions in the exiting `$Perms` permissions object that was created previously in the same Windows PowerShell session (the `$Perms` variable is still available and populated). +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 Windows PowerShell session, you can use `$Perms` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command. +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 variable that contains quarantine permissions object that you want to modify. For example if you ran the command `$Perms = New-QuarantinePermissions `, use the value `$Perms` for this parameter. +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 @@ -60,17 +63,36 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: True -Position: Named +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: The Block sender button is included in end-user quarantine notifications. -- $false: The Block sender button is not included in end-user quarantine notifications. This is the default value. +- $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 @@ -79,7 +101,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -88,8 +110,8 @@ Accept wildcard characters: False ### -PermissionToDelete The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: -- $true: The Remove from quarantine button is included in the quarantined message details. -- $false: The Remove from quarantine button is not included in the quarantined message details. This is the default value. +- $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 @@ -98,7 +120,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -110,7 +132,7 @@ The PermissionToDownload parameter specifies whether users are allowed to downlo - $true: The permission is enabled. - $false: The permission is disabled. This is the default value. -Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details. +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 @@ -119,7 +141,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -128,8 +150,8 @@ Accept wildcard characters: False ### -PermissionToPreview The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: -- $true: The Preview message button is included in the quarantined message details. -- $false: The Preview message button is not included in the quarantined message details. This is the default value. +- $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 @@ -138,17 +160,17 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +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 messages from quarantine. Valid values are: +The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: -- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details. -- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value. +- $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. @@ -159,7 +181,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -168,8 +190,8 @@ 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: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details. -- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value. +- $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. @@ -180,7 +202,7 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -192,7 +214,7 @@ The PermissionToViewHeader parameter specifies whether users are allowed to view - $true: The permission is enabled. - $false: The permission is disabled. This is the default value. -Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details. The View message header button is always available in the quarantined message details. +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 @@ -201,22 +223,19 @@ Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False -Position: Named +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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index 68cc62d644..796d65b9a1 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-quarantinepolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepolicy applicable: Exchange Online, Exchange Online Protection title: Set-QuarantinePolicy schema: 2.0.0 @@ -14,14 +14,14 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-QuarantinePolicy cmdlet to modify custom quarantine policies in your cloud-based organization. +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://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-QuarantineTag [-Identity] +Set-QuarantinePolicy [-Identity] [-AdminNotificationFrequencyInDays ] [-AdminNotificationLanguage ] [-AdminNotificationsEnabled ] @@ -31,22 +31,27 @@ Set-QuarantineTag [-Identity] [-DomainController ] [-EndUserQuarantinePermissions ] [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] [-EndUserSpamNotificationFrequencyInDays ] [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] [-ESNEnabled ] [-IgnoreDehydratedFlag] + [-IncludeMessagesFromBlockedSenderAddress ] [-MultiLanguageCustomDisclaimer ] [-MultiLanguageSenderName ] [-MultiLanguageSetting ] [-OrganizationBrandingEnabled ] [-QuarantineRetentionDays ] - [-WhatIf] [] + [-WhatIf] + [] ``` ## DESCRIPTION -You can't modify built-in quarantine policies with names that start with "Default". +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,13 +64,15 @@ This example configures the permissions in the quarantine policy named CustomAcc ### 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.') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -OrganizationBrandingEnabled $true +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): -- The specified custom disclaimer text and email sender's display name are used for English, Chinese, and French. +- 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 @@ -206,7 +213,11 @@ Accept wildcard characters: False ``` ### -EndUserQuarantinePermissions -This parameter is reserved for internal Microsoft use. +**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 @@ -226,23 +237,25 @@ The EndUserQuarantinePermissionsValue parameter specifies the end-user permissio 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** button in the details of the quarantined message. -- PermissionToDownload: This setting is not used (the value 0 or 1 does nothing). -- PermissionToAllowSender: This setting is not used (the value 0 or 1 does nothing). +- 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 1. Set one to 1 and the other to 0, or set both to 0. -- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to 1. Set one to 1 and the other to 0, or set both to 0. +- 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 = 00011011, so use the decimal value 27. -- Full access: Binary = 00010111, so use the decimal value 23. +- 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) @@ -256,6 +269,42 @@ 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. @@ -289,11 +338,35 @@ 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.S +- $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 @@ -324,14 +397,33 @@ 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 can specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. +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 GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +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 @@ -353,7 +445,7 @@ You can specify multiple values separated by commas using the syntax: `('value1' 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 GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +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 @@ -377,7 +469,9 @@ You can specify multiple value separated by commas using the syntax: `('value1', 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 GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +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 @@ -395,10 +489,10 @@ 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://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your custom logo. +- $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 GlobalDefaultTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. +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 diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/exchange/Set-RMSTemplate.md index 55f021313d..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,9 +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). -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-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,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 @@ -75,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 @@ -94,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 @@ -110,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 diff --git a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md index 486228d436..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 diff --git a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md index 03bfcdd675..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 diff --git a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md index 5ccd98f4fd..b3552f8231 100644 --- a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-recordreviewnotificationtemplateconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-recordreviewnotificationtemplateconfig applicable: Security & Compliance title: Set-RecordReviewNotificationTemplateConfig schema: 2.0.0 @@ -16,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-RecordReviewNotificationTemplateConfig -IsCustomizedNotificationTemplate ``` ## 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://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 diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/exchange/Set-RemoteDomain.md index 174bdc6433..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) @@ -331,6 +337,11 @@ The IsInternal parameter specifies whether the recipients in the remote domain a - $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) @@ -520,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: diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md index 1c39c7a123..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 @@ -263,7 +263,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -654,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: @@ -1025,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. @@ -1348,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). -- A migrated shared mailbox cannot be converted to a regular mailbox and a migrated regular mailbox cannot be converted to a shared mailbox. +- 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 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 908e48324a..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 diff --git a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md b/exchange/exchange-ps/exchange/Set-ResubmitRequest.md index 900d1e9629..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,9 +39,13 @@ Set-RetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] [-PolicyTemplateInfo ] + [-PolicyRBACScopes ] + [-PriorityCleanup] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveModernGroupLocation ] @@ -63,20 +58,36 @@ Set-RetentionCompliancePolicy [-Identity] [-RemoveSkypeLocation ] [-RemoveSkypeLocationException ] [-RestrictiveRetention ] + [-StartSimulation ] [-WhatIf] [] ``` ### AdaptiveScopeLocation ``` -Set-RetentionCompliancePolicy [-Identity] - [-AddAdaptiveScopeLocation ] +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] [] ``` @@ -90,18 +101,22 @@ 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 $_}`. @@ -115,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 @@ -142,7 +244,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. @@ -288,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"`. @@ -306,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"`. @@ -340,11 +442,11 @@ 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 @@ -360,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"`. @@ -517,7 +619,7 @@ 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,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"`. +- 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 @@ -567,6 +669,32 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled The Enabled parameter specifies whether the policy is enabled. Valid values are: @@ -586,6 +714,27 @@ 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 +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. @@ -604,8 +753,28 @@ 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 +``` + ### -PolicyTemplateInfo -{{ Fill PolicyTemplateInfo Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable @@ -620,6 +789,22 @@ 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: @@ -643,12 +828,9 @@ 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: +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. -- 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: +You can use any value that uniquely identifies the mailbox. For example: - Name - Distinguished name (DN) @@ -671,12 +853,9 @@ 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: +The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. -- 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: +You can use any value that uniquely identifies the mailbox. For example: - Name - Distinguished name (DN) @@ -749,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"`. @@ -767,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"`. @@ -801,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"`. @@ -819,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"`. @@ -993,6 +1172,27 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md index 1e96ad719c..3a544e128a 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancerule +online version: https://learn.microsoft.com/powershell/module/exchange/set-retentioncompliancerule applicable: Security & Compliance title: Set-RetentionComplianceRule schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,7 +41,7 @@ Set-RetentionComplianceRule [-Identity] ``` ## 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://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 @@ -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. @@ -154,7 +156,7 @@ 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 @@ -172,7 +174,7 @@ 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 @@ -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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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. @@ -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"`. @@ -259,6 +261,38 @@ 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 +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: diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md index be5b48803c..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 @@ -128,10 +128,14 @@ The IsDefault switch specifies that this retention policy is the default retenti 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 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: Changes to which retention policy is the default are ignored. The retention policy specified in the mailbox plan is assigned to new mailboxes, and changing which policy is specified in the mailbox plan doesn't affect existing mailboxes. If you set the value back to blank, new mailboxes will use the default policy going forward. Existing mailboxes created during the time when a retention policy was specified in the mailbox plan will continue to use that policy, and are unaffected by changes to which retention policy is the default. Any existing mailboxes that you created during the last time when there was no retention policy specified in the mailbox plan will be continually affected by changes to which retention policy is the default. +- 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 @@ -223,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 diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md index 53e95cf1d4..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 @@ -246,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 diff --git a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md index 756c565760..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 diff --git a/exchange/exchange-ps/exchange/Set-RoleGroup.md b/exchange/exchange-ps/exchange/Set-RoleGroup.md index 34ad1e3629..b0c9fd04a3 100644 --- a/exchange/exchange-ps/exchange/Set-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Set-RoleGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-rolegroup +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 @@ -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" ``` @@ -260,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. @@ -276,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 ("). diff --git a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md index 6e00fce578..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 diff --git a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md index 4851958ce6..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 diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index 7d48d92abf..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,14 +16,13 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 ] @@ -35,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 @@ -65,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 @@ -77,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. @@ -92,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 @@ -127,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 @@ -146,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 @@ -159,7 +138,7 @@ 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. $false corresponds to the value **Off** for the **Safe Attachments unknown malware response** setting of the complete Safe Attachments policy in the Microsoft 365 Defender portal (the combination of the rule and the corresponding associated policy in PowerShell). +- $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 an existing Safe Attachments policy, use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. @@ -167,7 +146,7 @@ To enable or disable an existing Safe Attachments policy, use the Enable-SafeAtt Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -177,19 +156,23 @@ Accept wildcard characters: False ``` ### -QuarantineTag -The QuarantineTag 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: +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. To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,AdminNotification*`. +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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -199,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 @@ -218,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 @@ -240,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 diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md index 128f8fd766..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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,14 +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. > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Safe Attachments policy settings](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-attachments#safe-attachments-policy-settings). +> 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 @@ -71,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 @@ -87,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 @@ -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 Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -116,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 @@ -147,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 @@ -174,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 @@ -190,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 @@ -214,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 @@ -224,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 @@ -254,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 @@ -279,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 @@ -306,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 @@ -322,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 diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md index 324bb1d690..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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-SafeLinksPolicy [-Identity] [-AllowClickThrough ] [-Confirm] [-CustomNotificationText ] - [-DeliverMessageAfterScan + [-DeliverMessageAfterScan ] [-DisableUrlRewrite ] [-DoNotRewriteUrls ] [-EnableForInternalSenders ] @@ -44,7 +44,7 @@ Set-SafeLinksPolicy [-Identity] ## DESCRIPTION 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 @@ -68,7 +68,7 @@ The Identity parameter specifies the Safe Links policy that you want to modify. Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -84,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 @@ -96,14 +96,16 @@ Accept wildcard characters: False ### -AllowClickThrough 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. This is the default value. +$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 @@ -122,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 @@ -138,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 @@ -150,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,14 +171,16 @@ Accept wildcard characters: False ### -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). Typically, we don't recommend using this value. -- $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. +- $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. + +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 @@ -190,13 +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 +Applicable: Exchange Online Required: False Position: Named @@ -208,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 @@ -227,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 @@ -246,14 +250,14 @@ Accept wildcard characters: False ### -EnableSafeLinksForEmail The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for email. 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. 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 @@ -265,7 +269,7 @@ Accept wildcard characters: False ### -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. 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. +- $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. @@ -274,7 +278,7 @@ Note that this protection applies to links in Office documents, not links in ema Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -286,14 +290,14 @@ Accept wildcard characters: False ### -EnableSafeLinksForTeams The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. 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 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 @@ -305,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, including links that point to files, is enabled. -- $false: Real-time scanning of clicked links, 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 @@ -331,7 +335,7 @@ The TrackClicks parameter specifies whether to track user clicks related to Safe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -350,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 @@ -366,7 +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 +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md index 5f33464493..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Set-SafeLinksRule [-Identity] 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. > [!IMPORTANT] -> Different types of recipient conditions or different types of recipient exceptions are not additive; they're inclusive. For more information, see [Recipient filters in Safe Links policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-links#recipient-filters-in-safe-links-policies). +> 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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,9 @@ This example modifies the existing Safe Links rule named Contoso All to include ### Example 3 ```powershell $Data = Import-Csv -Path "C:\Data\SafeLinksDomains.csv" + $SLDomains = $Data.Domains + Set-SafeLinksRule -Identity "Contoso All" -RecipientDomainIs $SLDomains ``` @@ -85,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 @@ -101,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 @@ -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: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -130,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 @@ -161,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 @@ -188,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 @@ -204,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 @@ -228,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 @@ -238,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 @@ -268,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 @@ -293,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 @@ -320,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 @@ -336,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 diff --git a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md index 32e3da10b6..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 diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md index a2aaa3c442..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 +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 PowerShell. For more information, see [Security & Compliance 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 before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance](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 +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 +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 +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 +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 +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 +Applicable: Exchange Online Required: False Position: Named @@ -157,13 +193,15 @@ 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 PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SendConnector.md b/exchange/exchange-ps/exchange/Set-SendConnector.md index 18338276bf..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. @@ -626,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"`. diff --git a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md index 40ec920393..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 diff --git a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md b/exchange/exchange-ps/exchange/Set-SenderIdConfig.md index a8f7a100d3..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,7 +16,7 @@ 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 @@ -36,7 +36,7 @@ Set-SenderIdConfig ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES diff --git a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md b/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md index c7408953bd..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 diff --git a/exchange/exchange-ps/exchange/Set-ServerComponentState.md b/exchange/exchange-ps/exchange/Set-ServerComponentState.md index b4d8c49d16..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 diff --git a/exchange/exchange-ps/exchange/Set-ServerMonitor.md b/exchange/exchange-ps/exchange/Set-ServerMonitor.md index 52749001e1..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 a20b0dfd0f..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 diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/Set-SharingPolicy.md index 28f7e5e26b..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 @@ -210,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 diff --git a/exchange/exchange-ps/exchange/Set-SiteMailbox.md b/exchange/exchange-ps/exchange/Set-SiteMailbox.md index d34e5afb47..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 @@ -161,7 +159,7 @@ You can use this switch to run tasks programmatically where prompting for admini 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 @@ -190,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 @@ -219,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 @@ -235,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 @@ -251,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 @@ -269,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 @@ -288,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 @@ -304,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 diff --git a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md index 2edc9bc59f..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 diff --git a/exchange/exchange-ps/exchange/Set-SmimeConfig.md b/exchange/exchange-ps/exchange/Set-SmimeConfig.md index 56e78415ba..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: diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md index fcacb86540..ac5377657b 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 +online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 applicable: Security & Compliance title: Set-SupervisoryReviewPolicyV2 schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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,6 +27,9 @@ Set-SupervisoryReviewPolicyV2 [-Identity] [-Confirm] [-Enabled ] [-Force] + [-PolicyRBACScopes ] + [-PolicyTemplate ] + [-PreservationPeriodInDays ] [-RemoveReviewers ] [-RetentionPeriodInDays ] [-Reviewers ] @@ -36,7 +39,7 @@ Set-SupervisoryReviewPolicyV2 [-Identity] ``` ## 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://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 @@ -154,6 +157,54 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveReviewers The RemoveReviewers parameter specifies the SMTP addresses of reviewers to remove from the supervisory review policy. You can specify multiple email addresses separated by commas. diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md index bbffc88aff..3b3c0210d9 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule applicable: Security & Compliance title: Set-SupervisoryReviewRule schema: 2.0.0 @@ -12,30 +12,43 @@ ms.reviewer: # Set-SupervisoryReviewRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -71,6 +84,22 @@ 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 }} @@ -180,6 +209,166 @@ 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 }} @@ -196,6 +385,22 @@ 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 +``` + ### -SamplingRate The SamplingRate parameter specifies the percentage of communications for review. If you want reviewers to review all detected items, use the value 100. @@ -212,6 +417,22 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Set-SweepRule.md b/exchange/exchange-ps/exchange/Set-SweepRule.md index ce5a234f4f..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 diff --git a/exchange/exchange-ps/exchange/Set-SystemMessage.md b/exchange/exchange-ps/exchange/Set-SystemMessage.md index a4ee62f1b0..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: 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 0ad428e66e..843a7d4d31 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-tenantallowblocklistitems +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 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS 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. +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 @@ -30,6 +30,7 @@ Set-TenantAllowBlockListItems -Ids -ListType [-NoExpiration] [-Notes ] [-OutputJson] + [-RemoveAfter ] [] ``` @@ -43,13 +44,14 @@ Set-TenantAllowBlockListItems -Entries -ListType [-NoExpiration] [-Notes ] [-OutputJson] + [-RemoveAfter ] [] ``` ## DESCRIPTION -In most cases, you can't modify the URL, file, or sender values of an existing entry. The only exception is allow URL entries for phishing simulations (Action = Allow, ListType = URL, and ListSubType = AdvancedDelivery). For more information about allowing URLs for phishing simulations, 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). +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://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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,10 +77,11 @@ The Entries parameter specifies the entries that you want to modify based on the - 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 (file, sender, or URL) or allow and block actions in the same command. +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. @@ -120,6 +123,7 @@ The ListType parameter specifies the type of entry that you want to modify. Vali - FileHash - Sender - Url +- IP Use the Entries or Ids parameter with this parameter to identify the entry itself. @@ -139,7 +143,11 @@ 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 block entries or with url allow entries where the ListSubType parameter value is AdvancedDelivery. +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. @@ -163,7 +171,7 @@ The Allow switch specifies that you're modifying an allow entry. You don't need Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -194,9 +202,9 @@ 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). -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 @@ -214,14 +222,14 @@ 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 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). +- 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, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -264,6 +272,28 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md index e6992cb7a5..e410aa39ca 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-tenantallowblocklistspoofitems +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 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-TenantAllowBlockListSpoofItems cmdlet to modify spoofed sender entries in the Tenant Allow/Block 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 @@ -30,13 +30,14 @@ Set-TenantAllowBlockListSpoofItems [-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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index ff06774c56..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 diff --git a/exchange/exchange-ps/exchange/Set-TransportAgent.md b/exchange/exchange-ps/exchange/Set-TransportAgent.md index 91a17c3cf8..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,7 +31,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index 44fb9e60e1..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 @@ -61,6 +61,8 @@ Set-TransportConfig [[-Identity] ] [-MaxRetriesForLocalSiteShadow ] [-MaxRetriesForRemoteSiteShadow ] [-MaxSendSize ] + [-MessageExpiration ] + [-PreventDuplicateJournalingEnabled ] [-QueueDiagnosticsAggregationInterval ] [-RejectMessageOnShadowFailure ] [-ReplyAllStormBlockDurationHours ] @@ -89,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 @@ -107,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 @@ -132,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 @@ -307,10 +309,10 @@ 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. +- 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. @@ -695,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 @@ -771,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. @@ -805,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. @@ -868,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 @@ -964,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. @@ -1142,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. @@ -1164,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. diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index c1c1b30426..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 @@ -207,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 @@ -243,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 @@ -261,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. @@ -313,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: @@ -336,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: @@ -392,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: @@ -425,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: @@ -456,8 +460,6 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressContainsWords -**Note**: In the cloud-based service, this parameter behaves the same as the RecipientAddressContainsWords parameter (other recipients in the message are not affected). - 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 available on Mailbox servers and Edge Transport servers. @@ -482,8 +484,6 @@ Accept wildcard characters: False ``` ### -AnyOfRecipientAddressMatchesPatterns -**Note**: In the cloud-based service, this parameter behaves the same as the RecipientAddressMatchesPatterns parameter (other recipients in the message are not affected). - 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 available on Mailbox servers and Edge Transport servers. @@ -510,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: @@ -543,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: @@ -576,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: @@ -609,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: @@ -642,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. @@ -664,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: + +- 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. -The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be added to a message. Valid values are: + 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. -- 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 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. @@ -690,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: @@ -715,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 @@ -780,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 ("). @@ -788,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 @@ -806,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. @@ -828,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) @@ -848,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) @@ -871,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. @@ -894,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 @@ -919,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. @@ -943,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"`. @@ -963,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: @@ -988,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: @@ -1059,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: @@ -1088,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: @@ -1181,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. @@ -1276,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 @@ -1312,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. @@ -1364,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: @@ -1387,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: @@ -1420,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: @@ -1453,9 +1498,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords -**Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressContainsWords parameter (other recipients in the message are not affected). - -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. @@ -1479,9 +1522,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns -**Note**: In the cloud-based service, this parameter behaves the same as the ExceptIfRecipientAddressMatchesPatterns parameter (other recipients in the message are not affected). - -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. @@ -1505,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: @@ -1538,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: @@ -1571,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: @@ -1604,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: @@ -1637,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. @@ -1659,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) @@ -1679,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) @@ -1702,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. @@ -1725,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 @@ -1750,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. @@ -1774,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"`. @@ -1794,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: @@ -1819,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: @@ -1858,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. @@ -1888,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: @@ -1917,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: @@ -1946,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. @@ -1968,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: @@ -1999,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. @@ -2021,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. @@ -2029,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) @@ -2043,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: @@ -2074,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 @@ -2097,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. @@ -2123,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: @@ -2146,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: @@ -2169,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. @@ -2189,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. @@ -2213,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. @@ -2233,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. @@ -2255,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: @@ -2286,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: @@ -2311,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[] @@ -2335,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. @@ -2365,14 +2420,14 @@ 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. +- 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 using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -2395,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. @@ -2451,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. @@ -2505,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. @@ -2525,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"`. @@ -2547,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[] @@ -2587,11 +2642,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -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 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 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: @@ -2614,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. @@ -2670,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. @@ -2724,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). @@ -2766,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: @@ -2778,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) @@ -2792,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: @@ -2815,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: @@ -2844,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: @@ -2871,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 @@ -2896,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[] @@ -2918,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. @@ -2938,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[] @@ -2960,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. @@ -2980,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: @@ -3004,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 @@ -3026,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: @@ -3085,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) @@ -3101,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: @@ -3136,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 @@ -3155,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: @@ -3166,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 @@ -3184,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: @@ -3197,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) @@ -3213,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. @@ -3239,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: @@ -3260,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: @@ -3371,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. @@ -3381,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. @@ -3414,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: @@ -3465,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: @@ -3496,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: @@ -3519,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. @@ -3577,12 +3642,12 @@ 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. +- 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 using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). @@ -3607,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 @@ -3627,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: @@ -3652,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: @@ -3697,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: @@ -3784,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) @@ -3800,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. @@ -3856,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. @@ -3910,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. @@ -3930,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"`. @@ -3954,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 @@ -3973,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[] @@ -4042,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. @@ -4068,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". @@ -4162,7 +4235,12 @@ This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. -{{ Fill RemoveRMSAttachmentEncryption Description }} +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 @@ -4204,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: @@ -4246,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 @@ -4263,11 +4341,9 @@ Accept wildcard characters: False ``` ### -SCLOver -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. -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: @@ -4292,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. @@ -4348,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. @@ -4402,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 @@ -4430,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). @@ -4472,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: @@ -4482,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) @@ -4498,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: @@ -4521,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: @@ -4550,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: @@ -4581,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 @@ -4606,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: @@ -4765,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[] @@ -4807,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[] @@ -4861,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: diff --git a/exchange/exchange-ps/exchange/Set-TransportServer.md b/exchange/exchange-ps/exchange/Set-TransportServer.md index bd6abe4a36..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 diff --git a/exchange/exchange-ps/exchange/Set-TransportService.md b/exchange/exchange-ps/exchange/Set-TransportService.md index 0b42be459f..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. diff --git a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md index 3909e8ddf0..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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md index 4500eab37e..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 diff --git a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md index 91cd0db933..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 diff --git a/exchange/exchange-ps/exchange/Set-UMDialPlan.md b/exchange/exchange-ps/exchange/Set-UMDialPlan.md index 4d9cb49610..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" ``` diff --git a/exchange/exchange-ps/exchange/Set-UMIPGateway.md b/exchange/exchange-ps/exchange/Set-UMIPGateway.md index 67ea2f9200..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 diff --git a/exchange/exchange-ps/exchange/Set-UMMailbox.md b/exchange/exchange-ps/exchange/Set-UMMailbox.md index 0e664c5446..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 @@ -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. diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md b/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md index b2c58930d7..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 diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md index c5ba2a7075..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 diff --git a/exchange/exchange-ps/exchange/Set-UMService.md b/exchange/exchange-ps/exchange/Set-UMService.md index a26264a06b..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 diff --git a/exchange/exchange-ps/exchange/Set-UmServer.md b/exchange/exchange-ps/exchange/Set-UmServer.md index 146f29ee00..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 diff --git a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md index e66e8efb88..b54bb64a99 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy applicable: Security & Compliance title: Set-UnifiedAuditLogRetentionPolicy schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 Purview compliance portal. +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 ## 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. +> [!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 @@ -126,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 @@ -157,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 @@ -170,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. @@ -178,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 @@ -193,7 +192,7 @@ The Alias parameter specifies the Exchange alias (also known as the mail nicknam 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 Azure AD Connect synchronization. +- $, &, ', \`, {, }, 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. @@ -201,7 +200,7 @@ The Alias value can contain letters, numbers and the following characters: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,7 +225,7 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -246,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 @@ -267,7 +266,7 @@ The AutoSubscribeNewMembers switch specifies whether to automatically subscribe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,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 @@ -298,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 @@ -323,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 @@ -346,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 @@ -362,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 @@ -378,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 @@ -394,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 @@ -410,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 @@ -426,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 @@ -442,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 @@ -458,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 @@ -474,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 @@ -490,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 @@ -506,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 @@ -522,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 @@ -538,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 @@ -554,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 @@ -570,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 @@ -586,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 @@ -608,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 @@ -624,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 @@ -634,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: @@ -659,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 @@ -679,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 @@ -699,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 @@ -719,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 @@ -739,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 @@ -759,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 @@ -775,7 +773,7 @@ The ForceUpgrade switch suppresses the confirmation message that appears if the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -810,7 +808,7 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -829,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 @@ -841,15 +839,15 @@ 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. -- If Microsoft 365 Groups are hidden from Exchange clients, users cannot view the option to subscribe or unsubscribe to a Microsoft 365 Group. +- 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 @@ -870,7 +868,7 @@ The InformationBarrierMode parameter specifies the information barrier mode for Type: GroupInformationBarrierMode Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -886,7 +884,7 @@ Accept wildcard characters: False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -898,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 @@ -914,15 +912,13 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is available only in the cloud-based service. - 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 @@ -943,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 @@ -967,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 @@ -996,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 @@ -1025,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 @@ -1052,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 @@ -1073,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 @@ -1089,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 @@ -1105,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 @@ -1140,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 @@ -1159,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 @@ -1169,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 @@ -1200,7 +1196,7 @@ The SubscriptionEnabled switch specifies whether the group owners can enable sub Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1215,7 +1211,7 @@ The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disa - 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`. -This setting only controls email send by the Microsoft 365 Group. It doesn't control email sent by connected products (for example, Teams or Yammer). +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. @@ -1223,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 @@ -1239,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 diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/exchange/Set-User.md index 5ec5dcbb34..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 @@ -39,17 +39,22 @@ Set-User [-Identity] [-DesiredWorkloads ] [-DisplayName ] [-DomainController ] + [-EXOModuleEnabled ] [-Fax ] [-FirstName ] [-Force] [-GeoCoordinates ] [-HomePhone ] [-IgnoreDefaultScope] + [-IsShadowMailbox ] [-Initials ] [-LastName ] [-LinkedCredential ] [-LinkedDomainController ] [-LinkedMasterAccount ] + [-MailboxRegion ] + [-MailboxRegionSuffix ] + [-ManagedOnboardingType ] [-Manager ] [-MobilePhone ] [-Name ] @@ -90,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 @@ -116,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 @@ -291,7 +297,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -401,7 +407,7 @@ This parameter is available only in the cloud-based service. Type: Microsoft.Exchange.Data.MailboxWorkloadFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -444,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. @@ -502,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) @@ -570,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. @@ -591,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. @@ -659,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. @@ -678,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 @@ -806,13 +911,13 @@ Accept wildcard characters: False ``` ### -PermanentlyClearPreviousMailboxInfo -This parameter is not available or functional in on-premises Exchange. It is only available in Exchange Online. +This parameter is functional only in the cloud-based service. 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 @@ -830,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 @@ -912,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. + +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: -- $true: The user has access to remote PowerShell. -- $false: The user doesn't have access to remote PowerShell. +- $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) @@ -1080,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 @@ -1203,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 diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md index bff5ec4244..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 email for a user. For more details about configuring the Briefing email, 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,6 +103,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 @@ -105,4 +114,4 @@ Accept wildcard characters: False ## 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 0a0f428d5c..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,21 +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. -**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. -- In Microsoft Graph, the [Update-MgUserPhoto](https://docs.microsoft.com/powershell/module/microsoft.graph.users/update-mguserphoto) and [Set-MgUserPhotoContent](https://docs.microsoft.com/powershell/module/microsoft.graph.users/set-mguserphotocontent) cmdlets are also available. +**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 @@ -109,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 ``` @@ -141,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 @@ -151,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. @@ -159,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 @@ -177,7 +182,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded 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 @@ -190,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 @@ -206,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 @@ -219,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 @@ -237,7 +242,7 @@ A preview photo is the photo object that is uploaded to the user's account, but 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 @@ -253,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 @@ -268,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 @@ -282,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 @@ -306,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 @@ -327,7 +332,7 @@ This switch enables the command to access Active Directory objects that aren't c 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 @@ -343,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 @@ -359,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 diff --git a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md index 26697e510b..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 diff --git a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md index 57a6c7fa54..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 @@ -360,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 diff --git a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md index 9c9cca04a5..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 diff --git a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md index 63d913aee9..ddcb34db75 100644 --- a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-compliancesearch +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md index ba52c00346..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] -ReportTitle -ReportType -StartDate + [-BlockStatus ] [-CompressFile ] + [-ConnectorType ] [-DeliveryStatus ] [-Direction ] [-DLPPolicy ] @@ -35,6 +37,8 @@ Start-HistoricalSearch -EndDate -ReportTitle -ReportType ] [-RecipientAddress ] [-SenderAddress ] + [-SmtpSecurityError ] + [-TLSUsed ] [-TransportRule ] [-Url ] [] @@ -45,18 +49,18 @@ A historical search provides message trace and report details in a comma-separat 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 @@ -66,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". -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +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 use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: DateTime @@ -86,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 @@ -105,16 +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 +- ConnectorReport: Inbound/Outbound Message Report. - DLP: Data Loss Prevention 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 @@ -132,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 @@ -147,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 }} @@ -163,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: @@ -254,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 @@ -286,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 @@ -367,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 diff --git a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md index 2b9ea44d44..2afb3f3ca7 100644 --- a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication +online version: https://learn.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication applicable: Security & Compliance title: Start-InformationBarrierPoliciesApplication schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Start-InformationBarrierPoliciesApplication ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 @@ Start-InformationBarrierPoliciesApplication [[-Identity] ] ``` ## 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://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,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 d4f47f6825..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 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 diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md index 00f4058117..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,24 +16,23 @@ 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 ] - [-HoldCleanup] [-WhatIf] [] ``` -### HoldCleanup +### ComplianceBoundaryAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] -HoldCleanup +Start-ManagedFolderAssistant [-Identity] [-AdaptiveScope] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -42,9 +41,9 @@ Start-ManagedFolderAssistant [-Identity] -HoldCle [] ``` -### StopHoldCleanup +### ComplianceJobAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] [-StopHoldCleanup] +Start-ManagedFolderAssistant [-Identity] [-ComplianceJob] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -53,10 +52,9 @@ Start-ManagedFolderAssistant [-Identity] [-StopHo [] ``` -### ComplianceBoundaryAssistant +### DataGovernanceAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] - [-AdaptiveScope] +Start-ManagedFolderAssistant [-Identity] [-DataGovernance] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -65,9 +63,9 @@ Start-ManagedFolderAssistant [-Identity] [] ``` -### ComplianceJobAssistant +### ElcB2DumpsterArchiverAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] [-ComplianceJob] +Start-ManagedFolderAssistant [-Identity] [-B2DumpsterArchiver] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -76,9 +74,31 @@ Start-ManagedFolderAssistant [-Identity] [-Compli [] ``` -### DataGovernanceAssistant +### ElcB2IPMArchiverAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] [-DataGovernance] +Start-ManagedFolderAssistant [-Identity] [-B2IPMArchiver] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [] +``` + +### HoldCleanupParameterSet +``` +Start-ManagedFolderAssistant [-Identity] [-HoldCleanup] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [] +``` + +### StopHoldCleanupParameterSet +``` +Start-ManagedFolderAssistant [-Identity] [-StopHoldCleanup] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -96,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 @@ -145,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 @@ -176,14 +201,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AdaptiveScope +### -B2DumpsterArchiver This parameter is available only in the cloud-based service. -{{ Fill AdaptiveScope Description }} +{{ Fill B2DumpsterArchiver Description }} ```yaml Type: SwitchParameter -Parameter Sets: ComplianceBoundaryAssistant +Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet Aliases: Applicable: Exchange Online @@ -194,14 +219,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AggMailboxCleanup -This parameter is reserved for internal Microsoft use. +### -B2IPMArchiver +This parameter is available only in the cloud-based service. + +{{ Fill B2IPMArchiver Description }} ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: ElcB2IPMArchiverAssistantParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online Required: False Position: Named @@ -217,7 +244,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter -Parameter Sets: ComplianceJobAssistant +Parameter Sets: ComplianceJobAssistantParameterSet Aliases: Applicable: Exchange Online @@ -254,7 +281,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter -Parameter Sets: DataGovernanceAssistant +Parameter Sets: DataGovernanceAssistantParameterSet Aliases: Applicable: Exchange Online @@ -272,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 @@ -290,7 +317,7 @@ The FullCrawl switch recalculates the application of tags across the whole mailb ```yaml Type: SwitchParameter -Parameter Sets: ComplianceBoundaryAssistant, ComplianceJobAssistant, DataGovernanceAssistant, HoldCleanup, StopHoldCleanup +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: Applicable: Exchange Online @@ -301,6 +328,24 @@ 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. @@ -312,7 +357,7 @@ When you use this switch, items aren't moved from the inactive mailbox to the ar ```yaml Type: SwitchParameter -Parameter Sets: ComplianceBoundaryAssistant, ComplianceJobAssistant, DataGovernanceAssistant, HoldCleanup, StopHoldCleanup +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: Applicable: Exchange Online @@ -332,11 +377,11 @@ A hold clean-up command will run until it completely scans the Recoverable Items ```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 @@ -376,4 +421,4 @@ To see the return types, which are also known as output types, that this cmdlet ## 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 d14701817c..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 diff --git a/exchange/exchange-ps/exchange/Start-MigrationUser.md b/exchange/exchange-ps/exchange/Start-MigrationUser.md index 779a514218..be88fe1878 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Start-MigrationUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-migrationuser +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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Start-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 diff --git a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md b/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md index 90a1b663e7..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 diff --git a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md index ae374b4adf..a0b52107ee 100644 --- a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-compliancesearch +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 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md index 9786cbe9ee..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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 @@ -103,6 +103,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 22c3546be1..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 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 diff --git a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md index 7ec983b9e6..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 diff --git a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md b/exchange/exchange-ps/exchange/Stop-MigrationBatch.md index 24b77f5a19..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 diff --git a/exchange/exchange-ps/exchange/Stop-MigrationUser.md b/exchange/exchange-ps/exchange/Stop-MigrationUser.md index b19aca571b..ccaca8fe4d 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Stop-MigrationUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-migrationuser +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 @@ -16,7 +16,7 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Stop-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 diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md index 8e24287fa6..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 diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md index 50f49734d5..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 diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md index 58e7589cf4..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 diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md index 159a5a5d49..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 diff --git a/exchange/exchange-ps/exchange/Suspend-Message.md b/exchange/exchange-ps/exchange/Suspend-Message.md index 2168f97d86..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 ("). diff --git a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md b/exchange/exchange-ps/exchange/Suspend-MoveRequest.md index 6617969595..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 diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md index 6893671011..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 diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md index d41474290a..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 diff --git a/exchange/exchange-ps/exchange/Suspend-Queue.md b/exchange/exchange-ps/exchange/Suspend-Queue.md index 55f4fc7044..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 ("). diff --git a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md index ba6dc6bafb..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 @@ -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: diff --git a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md index 9d3a44194d..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 diff --git a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md b/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md index dcbcf1428a..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 diff --git a/exchange/exchange-ps/exchange/Test-AssistantHealth.md b/exchange/exchange-ps/exchange/Test-AssistantHealth.md index 2db87da520..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. @@ -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. diff --git a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md index 72b1d2b073..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: diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md index d4d1f9cc1b..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 +> [!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 diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/exchange/Test-DataClassification.md index f232dbb56c..7d9109fd68 100644 --- a/exchange/exchange-ps/exchange/Test-DataClassification.md +++ b/exchange/exchange-ps/exchange/Test-DataClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-dataclassification +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 @@ -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 @@ -33,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 ``` diff --git a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md index a10ba98bce..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: diff --git a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md b/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md index 632f620e9e..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 diff --git a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md b/exchange/exchange-ps/exchange/Test-ExchangeSearch.md index b284938eba..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 diff --git a/exchange/exchange-ps/exchange/Test-FederationTrust.md b/exchange/exchange-ps/exchange/Test-FederationTrust.md index 0230e07b3b..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 diff --git a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md b/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md index c7b1a80c28..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 diff --git a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md index c61d8cb6ee..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 diff --git a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md index 9b3971750f..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 diff --git a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md b/exchange/exchange-ps/exchange/Test-IRMConfiguration.md index 61d1ecbc9d..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@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)` @@ -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: diff --git a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md index 6ad285f036..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -151,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 diff --git a/exchange/exchange-ps/exchange/Test-Mailflow.md b/exchange/exchange-ps/exchange/Test-Mailflow.md index 19c6b21fea..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 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 b7f7bc1458..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} ``` @@ -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 diff --git a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md b/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md index 7416aa0c62..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 @@ -34,7 +34,7 @@ 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 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 diff --git a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md index d03a010c1f..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 diff --git a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md index 5a1c63a7af..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 @@ -407,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. diff --git a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md index 720830b524..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 @@ -16,11 +16,11 @@ 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 @@ -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 diff --git a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md b/exchange/exchange-ps/exchange/Test-OwaConnectivity.md index 0c9b4aa73b..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,41 +128,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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. +### -MailboxCredential +The MailboxCredential parameter specifies the mailbox credential for a single URL test. -If you don't use this switch, the command skips virtual directories that don't require SSL, and an error is generated. +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 ``` diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/exchange/Test-PopConnectivity.md index 76bcaf17ce..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: diff --git a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md index d88915895f..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: diff --git a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md b/exchange/exchange-ps/exchange/Test-ReplicationHealth.md index dcb8154e3f..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 diff --git a/exchange/exchange-ps/exchange/Test-SenderId.md b/exchange/exchange-ps/exchange/Test-SenderId.md index 68f7476b09..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 diff --git a/exchange/exchange-ps/exchange/Test-ServiceHealth.md b/exchange/exchange-ps/exchange/Test-ServiceHealth.md index 610d7b418d..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 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 9a484c31ed..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 @@ -97,7 +97,7 @@ If you don't use this switch, and you aren't a member or owner of the site mailb 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. @@ -181,7 +179,7 @@ You can't use this switch with the RequestorIdentity parameter. 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 diff --git a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md index 1bfa25a8b8..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 diff --git a/exchange/exchange-ps/exchange/Test-SystemHealth.md b/exchange/exchange-ps/exchange/Test-SystemHealth.md index de8a3e07de..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 @@ -72,7 +72,7 @@ This example saves the output data as a byte stream to the variable named $SysHe ### -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 @@ -221,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 diff --git a/exchange/exchange-ps/exchange/Test-TextExtraction.md b/exchange/exchange-ps/exchange/Test-TextExtraction.md index 3aa58a74ed..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 @@ -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 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 @@ -29,27 +29,31 @@ 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. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $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 ([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 @@ -62,7 +66,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded 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 @@ -81,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 @@ -99,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 @@ -115,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 diff --git a/exchange/exchange-ps/exchange/Test-UMConnectivity.md b/exchange/exchange-ps/exchange/Test-UMConnectivity.md index 4cda9f3838..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 diff --git a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md index 1294bee871..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 @@ -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. diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md index 19f635c490..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -68,37 +68,37 @@ This example recovers the deleted mailbox for the user Brian Johnson. When this ## 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 ``` diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md index 8a9a95a4e7..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 diff --git a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md b/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md index c5a9958af4..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 diff --git a/exchange/exchange-ps/exchange/Update-AddressList.md b/exchange/exchange-ps/exchange/Update-AddressList.md index d7ffdb042a..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 diff --git a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md index 0fb67292b4..dfbaff31dc 100644 --- a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-compliancecasemember +online version: https://learn.microsoft.com/powershell/module/exchange/update-compliancecasemember applicable: Security & Compliance title: Update-ComplianceCaseMember schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Update-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md b/exchange/exchange-ps/exchange/Update-DatabaseSchema.md index 4e1c0b3663..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 diff --git a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md index 0c17bfe2f8..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 diff --git a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md deleted file mode 100644 index 8a594cd308..0000000000 --- a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md +++ /dev/null @@ -1,137 +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 904be164b7..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 diff --git a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md index ad6ad376d0..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 diff --git a/exchange/exchange-ps/exchange/Update-FileDistributionService.md b/exchange/exchange-ps/exchange/Update-FileDistributionService.md index b63e048ef1..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 diff --git a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md b/exchange/exchange-ps/exchange/Update-GlobalAddressList.md index 92b241c555..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 diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md index 254a70bde7..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 diff --git a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md index 55bb7ec5db..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 diff --git a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md index 59f855dea2..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 diff --git a/exchange/exchange-ps/exchange/Update-PublicFolder.md b/exchange/exchange-ps/exchange/Update-PublicFolder.md index b8102971d0..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 diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md index ddfe015a93..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`. diff --git a/exchange/exchange-ps/exchange/Update-SafeList.md b/exchange/exchange-ps/exchange/Update-SafeList.md index f11c5b91ae..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 ``` diff --git a/exchange/exchange-ps/exchange/Update-SiteMailbox.md b/exchange/exchange-ps/exchange/Update-SiteMailbox.md index 2c36ffc396..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 @@ -89,7 +89,7 @@ If you don't use this switch, and you aren't a member or owner of the site mailb 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 @@ -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 @@ -124,7 +124,7 @@ The FullSync switch specifies full sync is expensive and will have a performance 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 @@ -134,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 @@ -152,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 @@ -182,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 @@ -198,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 diff --git a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md b/exchange/exchange-ps/exchange/Update-StoreMailboxState.md index 2616f7aea3..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 3f83514cb0..bd36987193 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin +online version: https://learn.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin applicable: Security & Compliance title: Update-eDiscoveryCaseAdmin schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Update-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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 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 PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](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 diff --git a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md index 32e070f040..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,7 +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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ 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 @@ -93,6 +94,22 @@ 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). diff --git a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md index 185d981cbe..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 @@ -18,7 +18,7 @@ Use the Validate-OutboundConnector cmdlet to test the settings of Outbound conne **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 diff --git a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md index 2b7724e70f..c4a8ee7175 100644 --- a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md +++ b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/validate-retentionrulequery +online version: https://learn.microsoft.com/powershell/module/exchange/validate-retentionrulequery applicable: Exchange Online, Security & Compliance title: Validate-RetentionRuleQuery schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Validate-RetentionRuleQuery ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For 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 @@ Validate-RetentionRuleQuery -KqlQueryString ``` ## 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://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 @@ -42,7 +42,7 @@ 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, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +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 diff --git a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md b/exchange/exchange-ps/exchange/Write-AdminAuditLog.md index 512034a4b3..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 diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index abea8a9539..8ead57cb12 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -8,13 +8,13 @@ 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 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 V2 module](../../docs-conceptual/exchange-online-powershell-v2.md). +> 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: > @@ -69,10 +69,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Enable-SafeLinksRule](Enable-SafeLinksRule.md) -### [Get-AdvancedThreatProtectionDocumentDetail](Get-AdvancedThreatProtectionDocumentDetail.md) - -### [Get-AdvancedThreatProtectionDocumentReport](Get-AdvancedThreatProtectionDocumentReport.md) - ### [Get-AntiPhishPolicy](Get-AntiPhishPolicy.md) ### [Get-AntiPhishRule](Get-AntiPhishRule.md) @@ -95,8 +91,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MailTrafficATPReport](Get-MailTrafficATPReport.md) -### [Get-PhishFilterPolicy](Get-PhishFilterPolicy.md) - ### [Get-SafeAttachmentPolicy](Get-SafeAttachmentPolicy.md) ### [Get-SafeAttachmentRule](Get-SafeAttachmentRule.md) @@ -109,6 +103,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SafeLinksRule](Get-SafeLinksRule.md) +### [Get-SpoofIntelligenceInsight](Get-SpoofIntelligenceInsight.md) + ### [Get-SpoofMailReport](Get-SpoofMailReport.md) ### [New-AntiPhishPolicy](New-AntiPhishPolicy.md) @@ -153,8 +149,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-EmailTenantSettings](Set-EmailTenantSettings.md) -### [Set-PhishFilterPolicy](Set-PhishFilterPolicy.md) - ### [Set-SafeAttachmentPolicy](Set-SafeAttachmentPolicy.md) ### [Set-SafeAttachmentRule](Set-SafeAttachmentRule.md) @@ -186,6 +180,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Disable-MalwareFilterRule](Disable-MalwareFilterRule.md) +### [Disable-ReportSubmissionRule](Disable-ReportSubmissionRule.md) + ### [Enable-AntispamUpdates](Enable-AntispamUpdates.md) ### [Enable-EOPProtectionPolicyRule](Enable-EOPProtectionPolicyRule.md) @@ -198,12 +194,20 @@ 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) @@ -212,10 +216,16 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -252,8 +262,6 @@ 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) @@ -262,9 +270,11 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -272,6 +282,10 @@ 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) @@ -280,6 +294,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -294,13 +312,19 @@ 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) @@ -312,12 +336,18 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -338,22 +368,24 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-MalwareFilterRule](Remove-MalwareFilterRule.md) +### [Remove-PhishSimOverridePolicy](Remove-PhishSimOverridePolicy.md) + ### [Remove-QuarantinePolicy](Remove-QuarantinePolicy.md) -### [Remove-PhishSimOverridePolicy](Remove-PhishSimOverridePolicy.md) +### [Remove-ReportSubmissionPolicy](Remove-ReportSubmissionPolicy.md) -### [Remove-PhishSimOverrideRule](Remove-PhishSimOverrideRule.md) +### [Remove-ReportSubmissionRule](Remove-ReportSubmissionRule.md) ### [Remove-SecOpsOverridePolicy](Remove-SecOpsOverridePolicy.md) -### [Remove-SecOpsOverrideRule](Remove-SecOpsOverrideRule.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) @@ -362,6 +394,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -392,17 +428,19 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-MalwareFilterRule](Set-MalwareFilterRule.md) -### [Set-QuarantinePolicy](Set-QuarantinePolicy.md) - ### [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) @@ -410,6 +448,10 @@ 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) @@ -473,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) @@ -913,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) @@ -955,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) @@ -1022,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) @@ -1063,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) @@ -1127,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) @@ -1254,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) @@ -1266,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) @@ -1276,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) @@ -1306,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) @@ -1574,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) @@ -1596,6 +1662,8 @@ 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) @@ -1608,6 +1676,8 @@ 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) @@ -1628,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) @@ -1640,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) @@ -1671,14 +1749,14 @@ 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) @@ -1705,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) @@ -1721,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) @@ -1749,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) @@ -1771,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) @@ -1816,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) @@ -1828,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) @@ -1852,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) @@ -1924,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) @@ -2060,6 +2122,8 @@ 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) @@ -2118,6 +2182,8 @@ 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) @@ -2252,7 +2318,11 @@ 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) @@ -2261,11 +2331,9 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ConnectionInformation](Get-ConnectionInformation.md) -### [Get-CustomNudge](Get-CustomNudge.md) - -### [Get-CustomNudgeAssignment](Get-CustomNudgeAssignment.md) +### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) -### [Get-CustomNudgeSettings](Get-CustomNudgeSettings.md) +### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) ### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) @@ -2291,19 +2359,21 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaInsightsSettings](Get-VivaInsightsSettings.md) -### [New-CustomNudge](New-CustomNudge.md) +### [Get-VivaModuleFeature](Get-VivaModuleFeature.md) -### [New-CustomNudgeAssignment](New-CustomNudgeAssignment.md) +### [Get-VivaModuleFeatureEnablement](Get-VivaModuleFeatureEnablement.md) -### [Remove-CustomNudge](Remove-CustomNudge.md) +### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) -### [Remove-CustomNudgeAssignment](Remove-CustomNudgeAssignment.md) +### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md) -### [Set-CustomNudge](Set-CustomNudge.md) +### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) -### [Set-CustomNudgeAssignment](Set-CustomNudgeAssignment.md) +### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md) -### [Set-CustomNudgeSettings](Set-CustomNudgeSettings.md) +### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) + +### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) ### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) @@ -2311,51 +2381,17 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) +### [Update-VivaModuleFeaturePolicy](Update-VivaModuleFeaturePolicy.md) + ## reporting Cmdlets ### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) ### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) -### [Get-ConnectionByClientTypeDetailReport](Get-ConnectionByClientTypeDetailReport.md) - -### [Get-ConnectionByClientTypeReport](Get-ConnectionByClientTypeReport.md) - -### [Get-CsActiveUserReport](Get-CsActiveUserReport.md) - -### [Get-CsAVConferenceTimeReport](Get-CsAVConferenceTimeReport.md) - -### [Get-CsClientDeviceDetailReport](Get-CsClientDeviceDetailReport.md) - -### [Get-CsClientDeviceReport](Get-CsClientDeviceReport.md) - -### [Get-CsConferenceReport](Get-CsConferenceReport.md) - -### [Get-CsP2PAVTimeReport](Get-CsP2PAVTimeReport.md) - -### [Get-CsP2PSessionReport](Get-CsP2PSessionReport.md) - -### [Get-CsPSTNConferenceTimeReport](Get-CsPSTNConferenceTimeReport.md) - -### [Get-CsPSTNUsageDetailReport](Get-CsPSTNUsageDetailReport.md) - -### [Get-CsUserActivitiesReport](Get-CsUserActivitiesReport.md) - -### [Get-CsUsersBlockedReport](Get-CsUsersBlockedReport.md) - -### [Get-GroupActivityReport](Get-GroupActivityReport.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-MailDetailEncryptionReport](Get-MailDetailEncryptionReport.md) @@ -2372,18 +2408,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -2394,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) @@ -2420,6 +2430,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SupervisoryReviewTopCasesReport](Get-SupervisoryReviewTopCasesReport.md) +### [Test-Message](Test-Message.md] + ## role-based-access-control Cmdlets ### [Add-ManagementRoleEntry](Add-ManagementRoleEntry.md) @@ -2797,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) @@ -2813,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) @@ -2831,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) @@ -2855,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/mapping/monikerMapping.json b/exchange/mapping/MAML2Yaml/monikerMapping.json similarity index 91% rename from exchange/mapping/monikerMapping.json rename to exchange/mapping/MAML2Yaml/monikerMapping.json index 68fde33989..4e2ae5eca8 100644 --- a/exchange/mapping/monikerMapping.json +++ b/exchange/mapping/MAML2Yaml/monikerMapping.json @@ -6,7 +6,7 @@ "packageRoot": "exchange-ps", "serviceMap": "mapping/serviceMapping.json", "modules": { - "exchange": {} + "exchange": {} } } } \ No newline at end of file diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index c887703a72..b6691a949e 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -22,8 +22,6 @@ "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-AntiPhishPolicy": "defender-for-office-365", "Get-AntiPhishRule": "defender-for-office-365", "Get-ATPBuiltInProtectionRule": "defender-for-office-365", @@ -35,13 +33,13 @@ "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-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", "New-AntiPhishPolicy": "defender-for-office-365", "New-AntiPhishRule": "defender-for-office-365", @@ -64,7 +62,6 @@ "Set-AtpPolicyForO365": "defender-for-office-365", "Set-ATPProtectionPolicyRule": "defender-for-office-365", "Set-EmailTenantSettings": "defender-for-office-365", - "Set-PhishFilterPolicy": "defender-for-office-365", "Set-SafeAttachmentPolicy": "defender-for-office-365", "Set-SafeAttachmentRule": "defender-for-office-365", "Set-SafeLinksPolicy": "defender-for-office-365", @@ -80,22 +77,30 @@ "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", @@ -114,39 +119,49 @@ "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", "New-HostedOutboundSpamFilterRule": "antispam-antimalware", "New-MalwareFilterPolicy": "antispam-antimalware", "New-MalwareFilterRule": "antispam-antimalware", - "New-QuarantinePolicy": "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", @@ -157,18 +172,21 @@ "Remove-IPBlockListProvider": "antispam-antimalware", "Remove-MalwareFilterPolicy": "antispam-antimalware", "Remove-MalwareFilterRule": "antispam-antimalware", - "Remove-QuarantinePolicy": "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", @@ -184,15 +202,18 @@ "Set-MalwareFilteringServer": "antispam-antimalware", "Set-MalwareFilterPolicy": "antispam-antimalware", "Set-MalwareFilterRule": "antispam-antimalware", - "Set-QuarantinePolicy": "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", @@ -224,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", @@ -442,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", @@ -463,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", @@ -496,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", @@ -516,6 +536,7 @@ "Enable-Mailbox": "mailboxes", "Enable-ServiceEmailChannel": "mailboxes", "Enable-SweepRule": "mailboxes", + "Expedite-Delicensing": "mailboxes", "Export-MailboxDiagnosticLogs": "mailboxes", "Export-RecipientDataProperty": "mailboxes", "Get-App": "mailboxes", @@ -548,6 +569,7 @@ "Get-MailboxStatistics": "mailboxes", "Get-MailboxUserConfiguration": "mailboxes", "Get-MessageCategory": "mailboxes", + "Get-PendingDelicenseUser": "mailboxes", "Get-Place": "mailboxes", "Get-RecipientPermission": "mailboxes", "Get-RecoverableItems": "mailboxes", @@ -611,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", @@ -637,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", @@ -767,10 +798,12 @@ "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", @@ -781,12 +814,14 @@ "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", @@ -797,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", @@ -818,10 +857,10 @@ "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", @@ -835,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", @@ -843,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", @@ -857,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", @@ -868,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", @@ -890,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", @@ -943,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", @@ -1011,6 +1042,7 @@ "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", @@ -1040,6 +1072,7 @@ "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", @@ -1107,57 +1140,42 @@ "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-ConnectionInformation": "powershell-v2-module", - "Get-CustomNudge": "powershell-v2-module", - "Get-CustomNudgeAssignment": "powershell-v2-module", - "Get-CustomNudgeSettings": "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", - "New-CustomNudge": "powershell-v2-module", - "New-CustomNudgeAssignment": "powershell-v2-module", - "Remove-CustomNudge": "powershell-v2-module", - "Remove-CustomNudgeAssignment": "powershell-v2-module", - "Set-CustomNudge": "powershell-v2-module", - "Set-CustomNudgeAssignment": "powershell-v2-module", - "Set-CustomNudgeSettings": "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-MailDetailEncryptionReport": "reporting", "Get-MailDetailTransportRuleReport": "reporting", @@ -1166,30 +1184,18 @@ "Get-MailTrafficEncryptionReport": "reporting", "Get-MailTrafficPolicyReport": "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", + "Test-Message": "reporting", "Add-ManagementRoleEntry": "role-based-access-control", "Add-RoleGroupMember": "role-based-access-control", "Get-ManagementRole": "role-based-access-control", @@ -1376,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", @@ -1393,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", @@ -1405,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/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/monikerMapping.json b/officewebapps/mapping/MAML2Yaml/monikerMapping.json similarity index 89% rename from officewebapps/mapping/monikerMapping.json rename to officewebapps/mapping/MAML2Yaml/monikerMapping.json index f9897aa0d7..3c722651ec 100644 --- a/officewebapps/mapping/monikerMapping.json +++ b/officewebapps/mapping/MAML2Yaml/monikerMapping.json @@ -5,7 +5,7 @@ "referenceTocUrl": "/powershell/module/officewebapps-ps/toc.json", "packageRoot": "officewebapps-ps", "modules": { - "officewebapps": {} + "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 ec64b803cc..fbbbaaefc1 100644 --- a/repo_docs/NEW_CMDLETS.md +++ b/repo_docs/NEW_CMDLETS.md @@ -4,58 +4,45 @@ 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 or later, you already have Windows PowerShell 5.1 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 ``` -If you're running an older version of Windows, you need to install Windows PowerShell 5.1 as described below before you can install platyPS. - -**Notes**: - -- 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. - - For services that use remote PowerShell (Exchange), be aware of the following issues observed in different platyPS versions: - - - v0.14.0: Works fine. - - v0.14.1 and v0.14.2: Work fine, but produce bogus/nuisance errors using New-MarkdownHelp that can slow down operation. See this [platyPS GitHub issue](https://github.com/PowerShell/platyPS/issues/509) for details. This issue will likely be fixed in v2.0.0-Preview3. - - If all of the cmdlets are baked into the module itself, you likely won't have these issues (no dependence on remote PowerShell), so it doesn't matter which version you use. - -- Older versions of Windows don't automatically include Windows PowerShell 5.1. For the following versions of Windows, you need to download and install the Windows Management Framework (WMF) 5.1 from : - - - Windows Server 2012 or Windows Server 2012 R2 - - Windows Server 2008 R2 SP1\* - - Windows 8.1 - - Windows 7 Service SP1\* +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. - \* Also requires the Microsoft .NET Framework 4.5 or later. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). +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. - If you need to install platyPS on really old versions of Windows (for example, a server running a product that lacks support for WMF 5.1 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: -- 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) > [!TIP] > Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed. - Exchange: - - Exchange Online: [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) - - Security & Compliance: [Connect to Security & Compliance 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 (Teams and Exchange environments don't require this). The connection instructions topic should contain this and other connection requirements. + - 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) -- 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 @@ -68,7 +55,7 @@ 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. +> 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: @@ -103,89 +90,40 @@ Script 2.2.5 PowerShellGet {Find-Command, Find-Ds Script 2.0.0 PSReadline {Get-PSReadLineKeyHandler, Get-PSReadLineOption, Remove-PSReadLineKeyHandler, ... ``` -For services that use remote PowerShell (Exchange), 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 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 or other products that use remote PowerShell. **If you're using a product where all of the cmdlets are baked into the module itself, 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 - ``` - - > [!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 `MicrosoftTeams`). -- \ 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_. - - > [!IMPORTANT] - > Failure to use the _Session_ parameter in remote PowerShell environments that need it leads to weird results in the topic files. For example: - > - > - 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. - > - And more. - - If the \ location doesn't exist, it's created for you. #### Dump all cmdlets in the module/snap-in to files @@ -198,25 +136,23 @@ 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. @@ -240,7 +176,7 @@ Every cmdlet reference topic needs (at a minimum) the following properties in th ```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: @@ -252,7 +188,7 @@ 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) 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. @@ -289,13 +225,15 @@ 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: @@ -305,33 +243,26 @@ When you're done editing the topics, upload them to GitHub. Note that you need t - 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 @@ -339,7 +270,7 @@ Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is t - Exchange - > [!NOTE] + > [!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: @@ -354,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 +> 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. -### Reference +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 or later, Windows Server 2016 or later, or other versions of Windows where WMF 5.1 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 very old 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( @@ -422,30 +345,30 @@ To install platyPS on very old Windows clients or servers that are using PowerSh - `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 f4caba6c0f..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 and other products that use remote PowerShell, and the value is most likely `$Session`. - -If you're using Microsoft Teams 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,13 +106,13 @@ 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: @@ -123,35 +123,14 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po - 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. - - ![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/skype/docfx.json b/skype/docfx.json index 06ea3b0416..4b1f9f1bd1 100644 --- a/skype/docfx.json +++ b/skype/docfx.json @@ -43,6 +43,14 @@ "src": "skype-ps", "version": "skype-ps", "dest": "module/skype-ps" + }, + { + "files": [ + "**/*.md" + ], + "src": "virtual-folder", + "version": "skype-ps", + "dest": "module" } ], "resource": [ @@ -65,10 +73,11 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "serdarsoysal", "ms.author": "serdars", "manager": "serdars", - "ms.date": "09/25/2017", + "ms.date": "04/04/2023", "ms.topic": "reference", "ms.service": "skypeforbusiness-powershell", "products": [ @@ -77,9 +86,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": {}, "template": [], diff --git a/skype/docs-conceptual/intro.md b/skype/docs-conceptual/intro.md index 64c90dbe7d..309683be13 100644 --- a/skype/docs-conceptual/intro.md +++ b/skype/docs-conceptual/intro.md @@ -1,16 +1,16 @@ --- ms.localizationpriority: medium -title: Skype for Business cmdlet reference -description: "Learn about Skype for Business cmdlets." +title: Skype for Business Server cmdlet reference +description: "Learn about Skype for Business Server cmdlets." --- -# Skype for Business cmdlet reference +# Skype for Business Server cmdlet reference -Welcome to the Skype for Business PowerShell cmdlet help references. The Skype for Business cmdlets provide the command line interface for server and service administration and management. +Welcome to the Skype for Business Server PowerShell cmdlet help references. The Skype for Business Server cmdlets provide the command line interface for server administration and management. > [!IMPORTANT] -> As you migrate to Microsoft Teams you will find that some of the cmdlets in the Skype for Business Online module are also used for Microsoft Teams. To learn more about this, see: [Teams PowerShell Overview](/MicrosoftTeams/teams-powershell-overview). +> As you migrate to Microsoft Teams, to learn more, see: [Teams PowerShell Overview](/MicrosoftTeams/teams-powershell-overview). -Here you will find all of the Skype for Business and relevant Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here you will find all of the Skype for Business Server. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/skype/mapping/monikerMapping.json b/skype/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from skype/mapping/monikerMapping.json rename to skype/mapping/MAML2Yaml/monikerMapping.json diff --git a/skype/skype-ps/skype/Add-CsSlaDelegates.md b/skype/skype-ps/skype/Add-CsSlaDelegates.md index 48ec1b244b..3700e12bc1 100644 --- a/skype/skype-ps/skype/Add-CsSlaDelegates.md +++ b/skype/skype-ps/skype/Add-CsSlaDelegates.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/add-cssladelegates -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates +applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Add-CsSlaDelegates schema: 2.0.0 manager: rogupta @@ -143,4 +143,3 @@ The `Add-CsSlaDelegates` cmdlet returns a Microsoft.Rtc.Management.SlaConfigurat ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md index 23c0247ac1..e35882d1bb 100644 --- a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/approve-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skype/approve-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Approve-CsDeviceUpdateRule schema: 2.0.0 @@ -191,4 +191,3 @@ Instead, the `Approve-CsDeviceUpdateRule` cmdlet approves instances of the Micro [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Backup-CsPool.md b/skype/skype-ps/skype/Backup-CsPool.md index 02e07dd172..ebbf326a13 100644 --- a/skype/skype-ps/skype/Backup-CsPool.md +++ b/skype/skype-ps/skype/Backup-CsPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/backup-cspool +online version: https://learn.microsoft.com/powershell/module/skype/backup-cspool applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Backup-CsPool schema: 2.0.0 @@ -290,4 +290,3 @@ None. [Get-CsBackupServiceStatus](Get-CsBackupServiceStatus.md) [Get-CsPoolBackupRelationship](Get-CsPoolBackupRelationship.md) - diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md b/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md index 0056784f78..4565de64c5 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md +++ b/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/clear-csdeviceupdatefile +online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatefile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Clear-CsDeviceUpdateFile schema: 2.0.0 @@ -137,4 +137,3 @@ The `Clear-CsDeviceUpdateFile` cmdlet does not return any values. [Clear-CsDeviceUpdateLog](Clear-CsDeviceUpdateLog.md) [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md b/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md index 9131d5f825..37114a8907 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md +++ b/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/clear-csdeviceupdatelog +online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatelog applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Clear-CsDeviceUpdateLog schema: 2.0.0 @@ -154,4 +154,3 @@ The `Clear-CsDeviceUpdateLog` cmdlet does not return any values. [Clear-CsDeviceUpdateFile](Clear-CsDeviceUpdateFile.md) [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md b/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md deleted file mode 100644 index 70bf038e0d..0000000000 --- a/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/clear-csonlinetelephonenumberreservation -applicable: Skype for Business Online -title: Clear-CsOnlineTelephoneNumberReservation -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Clear-CsOnlineTelephoneNumberReservation - -## SYNOPSIS -Use the `Clear-CsOnlineTelephoneNumberReservation` cmdlet to clear a reserved list of telephone numbers before they are acquired. -The telephone numbers will then be available for search and reservation again. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Clear-CsOnlineTelephoneNumberReservation [-Tenant ] -ReservationId - -InventoryType [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -This cmdlet will fail if any of the numbers in the reservation have already been assigned. -An error message will identify the source of the failure. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Clear-CsOnlineTelephoneNumberReservation -ReservationId b1ae43f5-07ab-4b81-be32-4b8cc2d11f75 -InventoryType Service -``` - -This example clears a reservation with an inventory type of "Service". - - -## PARAMETERS - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -- "Service" for numbers assigned to conferencing support. - -- "Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -Specifies the identification of the reservation you want to clear. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### -None - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md b/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md index 6e70c34631..e6cc17f0f3 100644 --- a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/clear-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/clear-cspersistentchatroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Clear-CsPersistentChatRoom schema: 2.0.0 manager: rogupta @@ -180,4 +180,3 @@ None. Instead, `Clear-CsPersistentChatRoom` modifies existing instances of the M ## RELATED LINKS [Remove-CsPersistentChatMessage](Remove-CsPersistentChatMessage.md) - diff --git a/skype/skype-ps/skype/Convert-CsUserData.md b/skype/skype-ps/skype/Convert-CsUserData.md index 88b9a2c207..36e5bfd5b6 100644 --- a/skype/skype-ps/skype/Convert-CsUserData.md +++ b/skype/skype-ps/skype/Convert-CsUserData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/convert-csuserdata +online version: https://learn.microsoft.com/powershell/module/skype/convert-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Convert-CsUserData schema: 2.0.0 @@ -204,4 +204,3 @@ The `Convert-CsUserData` cmdlet creates either XML or ZIP files, depending on wh [Sync-CsUserData](Sync-CsUserData.md) [Update-CsUserData](Update-CsUserData.md) - diff --git a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md b/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md index ba8b9ec208..a337781345 100644 --- a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md +++ b/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/convertto-jsonforpsws +online version: https://learn.microsoft.com/powershell/module/skype/convertto-jsonforpsws applicable: Skype for Business Online title: ConvertTo-JsonForPSWS schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # ConvertTo-JsonForPSWS @@ -176,5 +176,4 @@ You can pipe any object to ConvertTo-JsonForPSWS. ## RELATED LINKS -[ConvertTo-Json](https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-6) - +[ConvertTo-Json](https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-6) diff --git a/skype/skype-ps/skype/Copy-CsVoicePolicy.md b/skype/skype-ps/skype/Copy-CsVoicePolicy.md index ec2ee672ed..2b2f8404d0 100644 --- a/skype/skype-ps/skype/Copy-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Copy-CsVoicePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/copy-csvoicepolicy -applicable: Lync Server 2013, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/copy-csvoicepolicy +applicable: Lync Server 2013 title: Copy-CsVoicePolicy schema: 2.0.0 manager: bulenteg @@ -135,4 +135,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md b/skype/skype-ps/skype/Debug-CsAddressBookReplication.md index 09f1f4b773..1afa8db7a1 100644 --- a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md +++ b/skype/skype-ps/skype/Debug-CsAddressBookReplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-csaddressbookreplication +online version: https://learn.microsoft.com/powershell/module/skype/debug-csaddressbookreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsAddressBookReplication schema: 2.0.0 @@ -307,4 +307,3 @@ The Debug-CsAddressBookReplication cmdlet returns instances of the Microsoft.Rtc [Test-CsAddressBookService](Test-CsAddressBookService.md) [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) - diff --git a/skype/skype-ps/skype/Debug-CsDataConference.md b/skype/skype-ps/skype/Debug-CsDataConference.md index a4c57fe0b3..6db0f9115d 100644 --- a/skype/skype-ps/skype/Debug-CsDataConference.md +++ b/skype/skype-ps/skype/Debug-CsDataConference.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-csdataconference +online version: https://learn.microsoft.com/powershell/module/skype/debug-csdataconference applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsDataConference schema: 2.0.0 @@ -124,4 +124,3 @@ The Debug-CsDataConference cmdlet does not accept pipelined input. ## RELATED LINKS [Test-CsDataConference](Test-CsDataConference.md) - diff --git a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md b/skype/skype-ps/skype/Debug-CsInterPoolReplication.md index 49e3ff72e9..ebc215436e 100644 --- a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md +++ b/skype/skype-ps/skype/Debug-CsInterPoolReplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-csinterpoolreplication +online version: https://learn.microsoft.com/powershell/module/skype/debug-csinterpoolreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsInterPoolReplication schema: 2.0.0 @@ -215,4 +215,3 @@ Debug-CsInterPoolReplication does not accept pipelined data. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md b/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md index c8625322bc..5f9eb262df 100644 --- a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md +++ b/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-csintrapoolreplication +online version: https://learn.microsoft.com/powershell/module/skype/debug-csintrapoolreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsIntraPoolReplication schema: 2.0.0 @@ -249,4 +249,3 @@ Debug-CsIntraPoolReplication returns instances of the Microsoft.Rtc.Management.U [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) [Test-CsReplica](Test-CsReplica.md) - diff --git a/skype/skype-ps/skype/Debug-CsLisConfiguration.md b/skype/skype-ps/skype/Debug-CsLisConfiguration.md index c50d5143f8..11d2b846e0 100644 --- a/skype/skype-ps/skype/Debug-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Debug-CsLisConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/debug-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsLisConfiguration schema: 2.0.0 @@ -109,4 +109,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Export-CsLisConfiguration](Export-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md b/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md index 14a5e9b6e2..417dd26a22 100644 --- a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md +++ b/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-csstorageservicefailures +online version: https://learn.microsoft.com/powershell/module/skype/debug-csstorageservicefailures applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsStorageServiceFailures schema: 2.0.0 @@ -282,4 +282,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md b/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md index a784f4a021..df94000299 100644 --- a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md +++ b/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore +applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Debug-CsUnifiedContactStore schema: 2.0.0 manager: rogupta @@ -159,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Test-CsUnifiedContactStore](Test-CsUnifiedContactStore.md) - diff --git a/skype/skype-ps/skype/Disable-CsAdDomain.md b/skype/skype-ps/skype/Disable-CsAdDomain.md index dd51ae43ac..38a11de6d4 100644 --- a/skype/skype-ps/skype/Disable-CsAdDomain.md +++ b/skype/skype-ps/skype/Disable-CsAdDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-csaddomain +online version: https://learn.microsoft.com/powershell/module/skype/disable-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsAdDomain schema: 2.0.0 @@ -220,4 +220,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-CsAdDomain](Enable-CsAdDomain.md) [Get-CsAdDomain](Get-CsAdDomain.md) - diff --git a/skype/skype-ps/skype/Disable-CsAdForest.md b/skype/skype-ps/skype/Disable-CsAdForest.md index f55c633d5a..c417b7c00c 100644 --- a/skype/skype-ps/skype/Disable-CsAdForest.md +++ b/skype/skype-ps/skype/Disable-CsAdForest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-csadforest +online version: https://learn.microsoft.com/powershell/module/skype/disable-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsAdForest schema: 2.0.0 @@ -229,4 +229,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Disable-CsComputer.md b/skype/skype-ps/skype/Disable-CsComputer.md index 640b7ccc31..d6b985bdfd 100644 --- a/skype/skype-ps/skype/Disable-CsComputer.md +++ b/skype/skype-ps/skype/Disable-CsComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-cscomputer +online version: https://learn.microsoft.com/powershell/module/skype/disable-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsComputer schema: 2.0.0 @@ -195,4 +195,3 @@ Instead, Disable-CsComputer disables instances of the Microsoft.Rtc.Management.D [Get-CsComputer](Get-CsComputer.md) [Test-CsComputer](Test-CsComputer.md) - diff --git a/skype/skype-ps/skype/Disable-CsHostingProvider.md b/skype/skype-ps/skype/Disable-CsHostingProvider.md index e5b23f7907..ed00fbdde6 100644 --- a/skype/skype-ps/skype/Disable-CsHostingProvider.md +++ b/skype/skype-ps/skype/Disable-CsHostingProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skype/disable-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsHostingProvider schema: 2.0.0 @@ -202,4 +202,3 @@ Instead, the cmdlet disables instances of the Microsoft.Rtc.Management.WritableC [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Disable-CsMeetingRoom.md b/skype/skype-ps/skype/Disable-CsMeetingRoom.md index b3b5c3878e..15cd889743 100644 --- a/skype/skype-ps/skype/Disable-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Disable-CsMeetingRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-csmeetingroom -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsMeetingRoom schema: 2.0.0 manager: bulenteg @@ -185,4 +185,3 @@ Instead, Disable-CsMeetingRoom deletes instance of the Microsoft.Rtc.Management. [Move-CsMeetingRoom](Move-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md deleted file mode 100644 index e9129202f4..0000000000 --- a/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-csonlinedialinconferencinguser -applicable: Skype for Business Online -title: Disable-CsOnlineDialInConferencingUser -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Disable-CsOnlineDialInConferencingUser - -## SYNOPSIS - -> This cmdlet will be deprecated on December 31, 2021. To disable Audio Conferencing for a user, please unassign the Audio Conferencing license from the user or disable the Audio Conferencing component from the license that is assigned to the user. For additional information, see [Assign licenses to users](/microsoft-365/admin/manage/assign-licenses-to-users). - -Use the `Disable-CsOnlineDialInConferencingUser` cmdlet to prevent a Skype for Business Online user from using dial-in or audio conferencing through Skype for Business Online. - -## SYNTAX - -``` -Disable-CsOnlineDialInConferencingUser [-WhatIf] [-SendEmailFromDisplayName ] [-TenantDomain ] - [-SendEmailToAddress ] [-SendEmailFromAddress ] [-Confirm] [-SendEmail] [[-Identity] ] - [-Tenant ] [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -The `Disable-CsOnlineDialInConferencingUser` cmdlet validates that the user is provisioned for audio conferencing using Microsoft as the audio conferencing provider and then disables audio conferencing which prevents the user from setting up audio conferences or meetings. - -When a user is disabled, the conference ID or passcode that was assigned to the user is released so it can be used by another user that is enabled for dial-in or audio conferencing even if they have a license assigned to them. - -When you disable the user for audio conferencing using this cmdlet, it will check that the user belongs to the specified tenant or domain and any audio conferencing information is removed. - -If the user is enabled for a third-party audio conferencing provider (ACP) and the Active Directory information is set, the cmdlet will fail and you must use the Remove-CsUserACP cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -```powershell -Disable-CsOnlineDialInConferencingUser -Identity "Pilar Ackerman" -Confirm -``` - -This example disables user "Pilar Ackerman" from using audio conferencing and will prompt you to confirm the operation. - - -## PARAMETERS - -### -Identity -Specifies the identity of the user account that will be disabled for Skype for Business Online. -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmail -Send an email to the user containing their Audio Conference information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromAddress -You can specify the From Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromDisplayName and -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromDisplayName -You can specify the Display Name to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmailFromAddress and -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToAddress -You can specify the To Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -NOTE: This parameter is reserved for internal Microsoft use. - -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -NOTE: This parameter is reserved for internal Microsoft use. - -Specifies the domain name for the tenant or organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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 -[Enable-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/enable-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguser?view=skype-ps) diff --git a/skype/skype-ps/skype/Disable-CsPublicProvider.md b/skype/skype-ps/skype/Disable-CsPublicProvider.md index fc8779952e..7fe6d0507f 100644 --- a/skype/skype-ps/skype/Disable-CsPublicProvider.md +++ b/skype/skype-ps/skype/Disable-CsPublicProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skype/disable-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsPublicProvider schema: 2.0.0 @@ -192,4 +192,3 @@ Instead, the cmdlet disables instances of the Microsoft.Rtc.Management.WritableC [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Disable-CsUser.md b/skype/skype-ps/skype/Disable-CsUser.md index 75974ece4f..df9affeaa4 100644 --- a/skype/skype-ps/skype/Disable-CsUser.md +++ b/skype/skype-ps/skype/Disable-CsUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-csuser +online version: https://learn.microsoft.com/powershell/module/skype/disable-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsUser schema: 2.0.0 @@ -189,4 +189,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.ADConne [Enable-CsUser](Enable-CsUser.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Enable-CsAdDomain.md b/skype/skype-ps/skype/Enable-CsAdDomain.md index 965fcfb26c..c23a8ddc5c 100644 --- a/skype/skype-ps/skype/Enable-CsAdDomain.md +++ b/skype/skype-ps/skype/Enable-CsAdDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-csaddomain +online version: https://learn.microsoft.com/powershell/module/skype/enable-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsAdDomain schema: 2.0.0 @@ -248,4 +248,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-CsAdDomain](Disable-CsAdDomain.md) [Get-CsAdDomain](Get-CsAdDomain.md) - diff --git a/skype/skype-ps/skype/Enable-CsAdForest.md b/skype/skype-ps/skype/Enable-CsAdForest.md index 7d66e4eaf5..0ef2979fe9 100644 --- a/skype/skype-ps/skype/Enable-CsAdForest.md +++ b/skype/skype-ps/skype/Enable-CsAdForest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-csadforest +online version: https://learn.microsoft.com/powershell/module/skype/enable-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsAdForest schema: 2.0.0 @@ -245,4 +245,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Enable-CsComputer.md b/skype/skype-ps/skype/Enable-CsComputer.md index d8ae901f0c..7d94d1d9aa 100644 --- a/skype/skype-ps/skype/Enable-CsComputer.md +++ b/skype/skype-ps/skype/Enable-CsComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-cscomputer +online version: https://learn.microsoft.com/powershell/module/skype/enable-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsComputer schema: 2.0.0 @@ -178,4 +178,3 @@ Instead, the Enable-CsComputer cmdlet enables instances of the Microsoft.Rtc.Man [Get-CsComputer](Get-CsComputer.md) [Test-CsComputer](Test-CsComputer.md) - diff --git a/skype/skype-ps/skype/Enable-CsHostingProvider.md b/skype/skype-ps/skype/Enable-CsHostingProvider.md index 89c216e599..13691b8524 100644 --- a/skype/skype-ps/skype/Enable-CsHostingProvider.md +++ b/skype/skype-ps/skype/Enable-CsHostingProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skype/enable-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsHostingProvider schema: 2.0.0 @@ -200,4 +200,3 @@ Instead, the cmdlet enables instances of the Microsoft.Rtc.Management.WritableCo [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Enable-CsMeetingRoom.md b/skype/skype-ps/skype/Enable-CsMeetingRoom.md index 30bedfcf7c..c823fe60ad 100644 --- a/skype/skype-ps/skype/Enable-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Enable-CsMeetingRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-csmeetingroom -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/enable-csmeetingroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsMeetingRoom schema: 2.0.0 manager: bulenteg @@ -19,7 +19,7 @@ To enable a meeting room you must first create an Active Directory user account Note that, although meeting room objects are based on user accounts, these objects will not show up when you run the Get-CsUser cmdlet. This cmdlet was introduced in Lync Server 2013. -The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Online and Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: https://docs.microsoft.com/skypeforbusiness/deploy/deploy-clients/with-office-365 +The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: [Manage conferencing in Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/conferencing/conferencing). **Note**: This cmdlet is not supported for managing Microsoft Teams Rooms. You must use the methods described in the [Microsoft Teams Rooms](/microsoftteams/rooms) documentation to manage Microsoft Teams Rooms. @@ -47,7 +47,7 @@ Note that, for Skype for Business Server, there are no cmdlets for creating or r Instead, you use the Enable-CsMeetingRoom cmdlet to enable meeting rooms and the Disable-CsMeetingRoom cmdlet to disable meeting rooms. The resource account must already exist in order for you to enable the meeting room, and disabling a meeting room only removes that room from your collection of meeting rooms; it does not delete the resource mailbox account. -The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Online and Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: https://docs.microsoft.com/skypeforbusiness/deploy/deploy-clients/with-office-365 +The process for creating and updating meeting rooms differs depending on your deployment of Skype for Business Server. Make sure you are following the guidance here to set up your meeting rooms properly: [Manage conferencing in Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/conferencing/conferencing). The functions carried out by the Enable-CsMeetingRoom cmdlet are not available in the Skype for Business Server Control Panel. @@ -335,4 +335,3 @@ The cmdlet also accepts pipelined instances of the Active Directory user object. [Move-CsMeetingRoom](Move-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md deleted file mode 100644 index e894c3cc8a..0000000000 --- a/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-csonlinedialinconferencinguser -applicable: Skype for Business Online -title: Enable-CsOnlineDialInConferencingUser -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Enable-CsOnlineDialInConferencingUser - -## SYNOPSIS - -> [!NOTE] -> This cmdlet will be deprecated on December 31, 2021. To enable Audio Conferencing for a user, please assign an Audio Conferencing license to the user and the user will be automatically enabled. For additional information, see [Assign licenses to users](/microsoft-365/admin/manage/assign-licenses-to-users). - -Use the `Enable-CsOnlineDialInConferencingUser` cmdlet to enable a Skype for Business user to access audio conferencing through Skype for Business Online. - -## SYNTAX - -``` -Enable-CsOnlineDialInConferencingUser [-AllowPstnOnlyMeetings ] [-ServiceNumber ] - [-SendEmailFromDisplayName ] [-ConferenceId ] [-TenantDomain ] - [-TollFreeServiceNumber ] [-SendEmailToAddress ] [-SendEmailFromAddress ] [-SendEmail] - [[-Identity] ] [-Tenant ] [-AllowTollFreeDialIn ] [-DomainController ] - [-ReplaceProvider] [-Force] [] -``` - -## DESCRIPTION -The `Enable-CsOnlineDialInConferencingUser` cmdlet allows a Skype for Business user to access audio conferencing through Skype for Business Online. -The cmdlet will validate if the user has the correct license assigned. -If the user already uses Microsoft as the audio conferencing provider, the cmdlet will run without any errors but no changes are made to the user. -The user can be moved from a third-party audio conferencing provider to Microsoft as the PSTN conferencing provider by using the ReplaceProvider parameter. - -If the bridge information (BridgeID or BridgeName) isn't provided and the tenant is just using one audio conferencing bridge, the user is assigned to the bridge. -If the bridge information isn't provided and the tenant uses multiple audio conferencing bridges, the user is then assigned to the default bridge. - -The audio conferencing provider name and domain information is automatically set for the user when they are enabled for audio conferencing. - -> [!NOTE] -> If your conferencing provider is Microsoft, your users' conference IDs are set to Dynamic Only. This cannot be changed. Conference IDs are automatically set only for Skype for Business users enabled for Audio Conferencing. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:> Enable-CsOnlineDialInConferencingUser -Identity "Ken Meyer" -AllowPstnOnlyMeetings $false -ConferenceId 3659305 -ReplaceProvider -ServiceNumber 14255551234 -``` - -This example enables a user named Ken Meyer to use audio conferencing and set up Skype for Business Online dial-in meetings. -When the cmdlet runs, it will replace Ken's existing audio conferencing provider information, set the default phone number to 14255551234 and the ConferenceId for meetings to 3659305. - - -## PARAMETERS - -### -Identity -A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPstnOnlyMeetings -If true, non-authenticated users can start meetings. -If false, non-authenticated callers wait in the lobby until an authenticated user joins, thereby starting the meeting. -An authenticated user is a user who joins the meeting using a Skype for Business client, or the organizer that joined the meeting via dial-in conferencing and was authenticated by a PIN number. -The default is false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConferenceId -Specifies the ConferenceId that will be used by the user for dial-in meetings. The cmdlet will fail if: - -The ConferenceId is already being used in the bridge where the user is assigned, or to which the user would be assigned. - -The ConferenceId doesn't meet the ConferenceId format requirements. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: Passcode -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplaceProvider -If present, the ReplaceProvider switch causes the user's default conferencing provider information to be set to Microsoft. -If omitted, the Active Directory information will not be updated. - -If the ReplaceProvider parameter is not used and the user is enabled for a 3rd party conferencing provider, the cmdlet will fail. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmail -Send an email to the user that contains his Audio Conference information. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromAddress -This property has been deprecated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailFromDisplayName -This property has been deprecated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SendEmailToAddress -You can specify the To Address to send the email that contains the Audio Conference information. This parameter must be used together with -SendEmail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -Specifies the default phone number to be used by the user. -The default number is used in meeting invitations. -The service number parameter overwrites the default service number assigned to the bridge for the user. -The service number can be specified in the following formats: E.164 number, +\ and tel:\. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -Specifies the domain name for the tenant or organization. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TollFreeServiceNumber -Specifies a toll-free phone number to be used by the user. This number is then used in meeting invitations. -The toll-free number can be specified in the following formats: E.164 number, +\ and tel:\. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTollFreeDialIn -If true, specified toll-free number is used in meeting invitations. -If false, specified toll-free number is not allowed to be used in meeting invitations. -The default is true. -This setting can ONLY be managed using the TeamsAudioConferencingPolicy. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 -[Disable-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/disable-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) - -[New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) diff --git a/skype/skype-ps/skype/Enable-CsPublicProvider.md b/skype/skype-ps/skype/Enable-CsPublicProvider.md index f35b92ce9c..e94296ea51 100644 --- a/skype/skype-ps/skype/Enable-CsPublicProvider.md +++ b/skype/skype-ps/skype/Enable-CsPublicProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skype/enable-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsPublicProvider schema: 2.0.0 @@ -192,4 +192,3 @@ Instead, the cmdlet enables instances of the Microsoft.Rtc.Management.WritableCo [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Enable-CsReplica.md b/skype/skype-ps/skype/Enable-CsReplica.md index 1615cea13f..9b9ffe4c9e 100644 --- a/skype/skype-ps/skype/Enable-CsReplica.md +++ b/skype/skype-ps/skype/Enable-CsReplica.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-csreplica +online version: https://learn.microsoft.com/powershell/module/skype/enable-csreplica applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsReplica schema: 2.0.0 @@ -163,4 +163,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) - diff --git a/skype/skype-ps/skype/Enable-CsTopology.md b/skype/skype-ps/skype/Enable-CsTopology.md index 9f8ed1d733..6ea479e1df 100644 --- a/skype/skype-ps/skype/Enable-CsTopology.md +++ b/skype/skype-ps/skype/Enable-CsTopology.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-cstopology +online version: https://learn.microsoft.com/powershell/module/skype/enable-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsTopology schema: 2.0.0 @@ -215,4 +215,3 @@ Instead, the Enable-CsTopology cmdlet enables instances of the Microsoft.Rtc.Man [Test-CsSetupPermission](Test-CsSetupPermission.md) [Test-CsTopology](Test-CsTopology.md) - diff --git a/skype/skype-ps/skype/Enable-CsUser.md b/skype/skype-ps/skype/Enable-CsUser.md index 5318aec9be..edbb4b7306 100644 --- a/skype/skype-ps/skype/Enable-CsUser.md +++ b/skype/skype-ps/skype/Enable-CsUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/enable-csuser +online version: https://learn.microsoft.com/powershell/module/skype/enable-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Enable-CsUser schema: 2.0.0 @@ -326,4 +326,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.ADConne [Disable-CsUser](Disable-CsUser.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Export-CsArchivingData.md b/skype/skype-ps/skype/Export-CsArchivingData.md index 04827640d4..cd7d61b79f 100644 --- a/skype/skype-ps/skype/Export-CsArchivingData.md +++ b/skype/skype-ps/skype/Export-CsArchivingData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csarchivingdata +online version: https://learn.microsoft.com/powershell/module/skype/export-csarchivingdata applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsArchivingData schema: 2.0.0 @@ -338,6 +338,4 @@ The Export-CsArchivingData cmdlet returns Archiving database records in EML form [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) -[Export archived data in Skype for Business Server](https://docs.microsoft.com/skypeforbusiness/manage/archiving/export-archived-data) - - +[Export archived data in Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/archiving/export-archived-data) diff --git a/skype/skype-ps/skype/Export-CsConfiguration.md b/skype/skype-ps/skype/Export-CsConfiguration.md index 5f72adc319..07b09a1158 100644 --- a/skype/skype-ps/skype/Export-CsConfiguration.md +++ b/skype/skype-ps/skype/Export-CsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/export-csconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsConfiguration schema: 2.0.0 @@ -154,4 +154,3 @@ If called along with the AsBytes parameter, the Export-CsConfiguration cmdlet re ## RELATED LINKS [Import-CsConfiguration](Import-CsConfiguration.md) - diff --git a/skype/skype-ps/skype/Export-CsLisConfiguration.md b/skype/skype-ps/skype/Export-CsLisConfiguration.md index 2ff3b7ac9c..86b50a823e 100644 --- a/skype/skype-ps/skype/Export-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Export-CsLisConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/export-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsLisConfiguration schema: 2.0.0 @@ -16,7 +16,6 @@ ms.reviewer: Exports an Enterprise Voice Enhanced 9-1-1 (E9-1-1) configuration to a file in compressed format for backup purposes. This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ### FileName @@ -44,7 +43,6 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h `Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Export-CsLisConfiguration"}` - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -65,27 +63,20 @@ In this example, the LIS configuration is stored as an array of bytes in a varia ``` $lisconfig = Export-CsLisConfiguration -AsBytes -$lisconfig | Set-Content -Path C:\E911Config.bak -Encoding byte +[System.IO.File]::WriteAllBytes('C:\E911Config.bak', $lisconfig) -Get-Content -ReadCount 0 -Encoding byte -Path C:\E911Config.bak | Import-CsLisConfiguration +[System.IO.File]::ReadAllBytes('C:\E911Config.bak') | Import-CsLisConfiguration ``` Example 3 is a more complete version of Example 2. The first line is the same, we call the Export-CsLisConfiguration cmdlet with the AsBytes parameter to store the LIS configuration as an array of bytes in the variable $lisconfig. The rest of this example shows how to save that configuration to a file and then import it back into the location configuration database. -In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the Windows PowerShell Set-Content cmdlet. -We assign values to two parameters of the Set-Content cmdlet: Path and Encoding. -We assign the full path and file name of the file to which we want to save the configuration to the Path parameter. -We use the Encoding parameter with a value of byte to ensure the configuration is stored as an array of bytes. +In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the full path and file name of the file to which we want to save the configuration. Finally, in line 3 we import the configuration back into the location configuration database. -First we call the Get-Content cmdlet to retrieve the contents from the file. -We pass a value of 0 to the ReadCount property, which tells the Get-Content cmdlet to read all the contents of the file at once rather than one line at a time. -We again use the Encoding parameter with a value of byte to specify what type of data we're reading from the file. -Finally we pass the file name to the Path parameter. -The contents of the file that we read with the Get-Content cmdlet are piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location database. - +First we retrieve the contents from the file. +The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location database. ## PARAMETERS @@ -134,16 +125,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS ### Byte[] Returns a byte array when the AsBytes parameter is used. - ## NOTES - ## RELATED LINKS [Import-CsLisConfiguration](Import-CsLisConfiguration.md) @@ -155,4 +143,3 @@ Returns a byte array when the AsBytes parameter is used. [Unpublish-CsLisConfiguration](Unpublish-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index 16a20c13fc..0000000000 --- a/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csorganizationalautoattendantholidays -applicable: Skype for Business Online -title: Export-CsOrganizationalAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Export-CsOrganizationalAutoAttendantHolidays - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Export-CsPersistentChatData.md b/skype/skype-ps/skype/Export-CsPersistentChatData.md index 7e745771f8..c748866515 100644 --- a/skype/skype-ps/skype/Export-CsPersistentChatData.md +++ b/skype/skype-ps/skype/Export-CsPersistentChatData.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-cspersistentchatdata -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/export-cspersistentchatdata +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsPersistentChatData schema: 2.0.0 manager: rogupta @@ -251,4 +251,3 @@ The Export-CsPersistentChatData cmdlet creates .ZIP files. ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Export-CsRgsConfiguration.md b/skype/skype-ps/skype/Export-CsRgsConfiguration.md index 82abdad209..eb820753a3 100644 --- a/skype/skype-ps/skype/Export-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Export-CsRgsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/export-csrgsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsRgsConfiguration schema: 2.0.0 @@ -163,4 +163,3 @@ The Export-CsRgsConfiguration cmdlet creates compressed files with the .ZIP file ## RELATED LINKS [Import-CsRgsConfiguration](Import-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Export-CsUserData.md b/skype/skype-ps/skype/Export-CsUserData.md index 99ed482885..0a7cb7f3d3 100644 --- a/skype/skype-ps/skype/Export-CsUserData.md +++ b/skype/skype-ps/skype/Export-CsUserData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csuserdata +online version: https://learn.microsoft.com/powershell/module/skype/export-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsUserData schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md index 1ecfd75aa2..25ec18533d 100644 --- a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAVEdgeConfiguration schema: 2.0.0 @@ -176,4 +176,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md b/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md index 54a4b65035..11284940f2 100644 --- a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaccessedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csaccessedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAccessEdgeConfiguration schema: 2.0.0 @@ -152,4 +152,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsAdContact.md b/skype/skype-ps/skype/Get-CsAdContact.md index dcc3051e70..34b07fefb1 100644 --- a/skype/skype-ps/skype/Get-CsAdContact.md +++ b/skype/skype-ps/skype/Get-CsAdContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadcontact +online version: https://learn.microsoft.com/powershell/module/skype/get-csadcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdContact schema: 2.0.0 @@ -252,4 +252,3 @@ The Get-CsAdContact cmdlet accepts a pipelined string value representing the Ide [Get-CsAdUser](Get-CsAdUser.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsAdDomain.md b/skype/skype-ps/skype/Get-CsAdDomain.md index e67b8fe876..5bccf6a4ec 100644 --- a/skype/skype-ps/skype/Get-CsAdDomain.md +++ b/skype/skype-ps/skype/Get-CsAdDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaddomain +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdDomain schema: 2.0.0 @@ -184,4 +184,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-CsAdDomain](Disable-CsAdDomain.md) [Enable-CsAdDomain](Enable-CsAdDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsAdForest.md b/skype/skype-ps/skype/Get-CsAdForest.md index 87b73cfa70..7c4a94daab 100644 --- a/skype/skype-ps/skype/Get-CsAdForest.md +++ b/skype/skype-ps/skype/Get-CsAdForest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadforest +online version: https://learn.microsoft.com/powershell/module/skype/get-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdForest schema: 2.0.0 @@ -169,4 +169,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAdPrincipal.md b/skype/skype-ps/skype/Get-CsAdPrincipal.md index 962c5dbe46..408fcea9c1 100644 --- a/skype/skype-ps/skype/Get-CsAdPrincipal.md +++ b/skype/skype-ps/skype/Get-CsAdPrincipal.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadprincipal +online version: https://learn.microsoft.com/powershell/module/skype/get-csadprincipal applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdPrincipal schema: 2.0.0 @@ -258,4 +258,3 @@ For example, this syntax returns Active Directory principal information for the [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Get-CsAdServerSchema.md b/skype/skype-ps/skype/Get-CsAdServerSchema.md index 861c3f5e15..68b5c4a03e 100644 --- a/skype/skype-ps/skype/Get-CsAdServerSchema.md +++ b/skype/skype-ps/skype/Get-CsAdServerSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadserverschema +online version: https://learn.microsoft.com/powershell/module/skype/get-csadserverschema applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdServerSchema schema: 2.0.0 @@ -94,4 +94,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Install-CsAdServerSchema](Install-CsAdServerSchema.md) - diff --git a/skype/skype-ps/skype/Get-CsAdUser.md b/skype/skype-ps/skype/Get-CsAdUser.md index 7b8ed0cd56..64a6b36104 100644 --- a/skype/skype-ps/skype/Get-CsAdUser.md +++ b/skype/skype-ps/skype/Get-CsAdUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaduser +online version: https://learn.microsoft.com/powershell/module/skype/get-csaduser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdUser schema: 2.0.0 @@ -279,4 +279,3 @@ The Get-CsAdUser cmdlet accepts a pipelined string value representing the Identi ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md b/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md index fe7b6b307e..0e359015b0 100644 --- a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain +online version: https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdditionalInternalDomain schema: 2.0.0 @@ -105,4 +105,3 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md b/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md index f7fcb06325..7515253dc6 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAddressBookConfiguration schema: 2.0.0 @@ -167,4 +167,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md index b46e7a945b..17e9105af0 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAddressBookNormalizationConfiguration schema: 2.0.0 @@ -151,4 +151,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md index 395ed1a10c..d12fa7f30e 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAddressBookNormalizationRule schema: 2.0.0 @@ -153,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsAdminRole.md b/skype/skype-ps/skype/Get-CsAdminRole.md index bb2e6fcc5a..45ac191dd0 100644 --- a/skype/skype-ps/skype/Get-CsAdminRole.md +++ b/skype/skype-ps/skype/Get-CsAdminRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadminrole +online version: https://learn.microsoft.com/powershell/module/skype/get-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdminRole schema: 2.0.0 @@ -239,4 +239,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md b/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md index 8614d6ae1c..553b2ad153 100644 --- a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md +++ b/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csadminroleassignment +online version: https://learn.microsoft.com/powershell/module/skype/get-csadminroleassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAdminRoleAssignment schema: 2.0.0 @@ -128,4 +128,3 @@ The Get-CsAdminRoleAssignment cmdlet returns string values representing the RBAC ## RELATED LINKS [Get-CsAdminRole](Get-CsAdminRole.md) - diff --git a/skype/skype-ps/skype/Get-CsAllowedDomain.md b/skype/skype-ps/skype/Get-CsAllowedDomain.md index e97737d1b9..d929aab5aa 100644 --- a/skype/skype-ps/skype/Get-CsAllowedDomain.md +++ b/skype/skype-ps/skype/Get-CsAllowedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skype/get-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAllowedDomain schema: 2.0.0 @@ -180,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsAllowedDomain](Set-CsAllowedDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsAnalogDevice.md b/skype/skype-ps/skype/Get-CsAnalogDevice.md index 7f93e05fb8..395151838c 100644 --- a/skype/skype-ps/skype/Get-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Get-CsAnalogDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skype/get-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAnalogDevice schema: 2.0.0 @@ -295,4 +295,3 @@ The Get-CsAnalogDevice cmdlet accepts a pipelined string value that represents t [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Get-CsAnnouncement.md b/skype/skype-ps/skype/Get-CsAnnouncement.md index 0e3066e228..a6d35b457e 100644 --- a/skype/skype-ps/skype/Get-CsAnnouncement.md +++ b/skype/skype-ps/skype/Get-CsAnnouncement.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csannouncement +online version: https://learn.microsoft.com/powershell/module/skype/get-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAnnouncement schema: 2.0.0 @@ -194,4 +194,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAnnouncement](Set-CsAnnouncement.md) [Import-CsAnnouncementFile](Import-CsAnnouncementFile.md) - diff --git a/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md deleted file mode 100644 index 9f13f29240..0000000000 --- a/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csapplicationaccesspolicy -applicable: Skype for Business Online -title: Get-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni -author: frankpeng7 -ms.author: frpeng -ms.reviewer: ---- - -# Get-CsApplicationAccessPolicy - -## SYNOPSIS - -Retrieves information about the application access policy configured for use in the tenant. - -## SYNTAX - -### Identity - -``` -Get-CsApplicationAccessPolicy [-Identity ] -``` - -## DESCRIPTION - -This cmdlet retrieves information about the application access policy configured for use in the tenant. - -## EXAMPLES - -### Retrieve all application access policies - -``` -PS C:\> Get-CsApplicationAccessPolicy -``` - -The command shown above returns information of all application access policies that have been configured for use in the tenant. - -### Retrieve specific application access policy - -``` -PS C:\> Get-CsApplicationAccessPolicy -Identity "ASimplePolicy" -``` - -In the command shown above, information is returned for a single application access policy: the policy with the Identity ASimplePolicy. - - -## PARAMETERS - -### -Identity - -Unique identifier assigned to the policy when it was created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) -[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) diff --git a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsApplicationEndpoint.md index 0f38044e06..abcb4005cc 100644 --- a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md +++ b/skype/skype-ps/skype/Get-CsApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/get-csapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsApplicationEndpoint schema: 2.0.0 @@ -226,4 +226,3 @@ Accepts a pipelined string value representing the Identity of the application en ## RELATED LINKS [Move-CsApplicationEndpoint](Move-CsApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md b/skype/skype-ps/skype/Get-CsArchivingConfiguration.md index 7a13236ddc..55d5040275 100644 --- a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsArchivingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsArchivingConfiguration schema: 2.0.0 @@ -176,4 +176,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/Get-CsArchivingPolicy.md b/skype/skype-ps/skype/Get-CsArchivingPolicy.md index f2ab3b19c5..f7195895dc 100644 --- a/skype/skype-ps/skype/Get-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Get-CsArchivingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsArchivingPolicy schema: 2.0.0 @@ -208,4 +208,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md b/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md index 41954c0e7b..b3dc99ff07 100644 --- a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md +++ b/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaudioconferencingprovider +online version: https://learn.microsoft.com/powershell/module/skype/get-csaudioconferencingprovider applicable: Skype for Business Online title: Get-CsAudioConferencingProvider schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAudioConferencingProvider @@ -139,4 +139,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md b/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md index 182a0b8ae6..4829ab115f 100644 --- a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csaudiotestserviceapplication +online version: https://learn.microsoft.com/powershell/module/skype/get-csaudiotestserviceapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAudioTestServiceApplication schema: 2.0.0 @@ -205,4 +205,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsAudioTestServiceApplication](Set-CsAudioTestServiceApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsAuthConfig.md b/skype/skype-ps/skype/Get-CsAuthConfig.md index eea936f104..56541b3cdc 100644 --- a/skype/skype-ps/skype/Get-CsAuthConfig.md +++ b/skype/skype-ps/skype/Get-CsAuthConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csauthconfig -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csauthconfig +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAuthConfig schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md index 9f311b4e3e..9b8fbb11b7 100644 --- a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsAutodiscoverConfiguration schema: 2.0.0 manager: rogupta @@ -169,4 +169,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md b/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md index 095974a039..0807cde4a1 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csbackupserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsBackupServiceConfiguration schema: 2.0.0 @@ -133,4 +133,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsBackupServiceConfiguration](Remove-CsBackupServiceConfiguration.md) [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md b/skype/skype-ps/skype/Get-CsBackupServiceStatus.md index 1e42fca825..6b305b2b3c 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md +++ b/skype/skype-ps/skype/Get-CsBackupServiceStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csbackupservicestatus +online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupservicestatus applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsBackupServiceStatus schema: 2.0.0 @@ -122,4 +122,3 @@ Returns information about the backup service. ## RELATED LINKS [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md index 48cd60363e..7b0c12b2c5 100644 --- a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsBandwidthPolicyServiceConfiguration schema: 2.0.0 @@ -153,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsBandwidthPolicyServiceConfiguration](Remove-CsBandwidthPolicyServiceConfiguration.md) [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsBlockedDomain.md b/skype/skype-ps/skype/Get-CsBlockedDomain.md index 780078da96..4db4188c4b 100644 --- a/skype/skype-ps/skype/Get-CsBlockedDomain.md +++ b/skype/skype-ps/skype/Get-CsBlockedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skype/get-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsBlockedDomain schema: 2.0.0 @@ -175,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsBlockedDomain](Set-CsBlockedDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md index df30d67647..82470cd5a7 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csbroadcastmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingconfiguration applicable: Skype for Business Online title: Get-CsBroadcastMeetingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsBroadcastMeetingConfiguration @@ -146,4 +146,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md b/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md index d18f3a24e8..acdf4bbf3d 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md +++ b/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csbroadcastmeetingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingpolicy applicable: Skype for Business Online title: Get-CsBroadcastMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsBroadcastMeetingPolicy @@ -258,4 +258,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsBusyOptions.md b/skype/skype-ps/skype/Get-CsBusyOptions.md index ad2b099be5..717261c488 100644 --- a/skype/skype-ps/skype/Get-CsBusyOptions.md +++ b/skype/skype-ps/skype/Get-CsBusyOptions.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csbusyoptions +online version: https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsBusyOptions schema: 2.0.0 @@ -96,6 +96,6 @@ Microsoft.Rtc.Management.AD.UserIdParameter object. ## RELATED LINKS -[Remove-CsBusyOptions](https://docs.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://docs.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsCallParkOrbit.md b/skype/skype-ps/skype/Get-CsCallParkOrbit.md index 8fc926c69e..d13afad9f1 100644 --- a/skype/skype-ps/skype/Get-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/Get-CsCallParkOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skype/get-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsCallParkOrbit schema: 2.0.0 @@ -87,7 +87,7 @@ It does this by checking the StartsWith property of the NumberRangeStart object ### -------------------------- Example 6 -------------------------- ``` -Get-CsCallParkOrbit | Where-Object {\[Char\]::IsDigit($_.NumberRangeStart\[0\])} +Get-CsCallParkOrbit | Where-Object {[Char]::IsDigit($_.NumberRangeStart[0])} ``` The command in this example returns all call park orbit ranges where no prefix has been assigned to the numbers in the range. @@ -208,4 +208,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsCallParkOrbit](Remove-CsCallParkOrbit.md) [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) - diff --git a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md index d1ed3a00e0..5bf6b230bd 100644 --- a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsCallViaWorkPolicy schema: 2.0.0 @@ -145,4 +145,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsCdrConfiguration.md b/skype/skype-ps/skype/Get-CsCdrConfiguration.md index 703ec90961..2b953208c4 100644 --- a/skype/skype-ps/skype/Get-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/Get-CsCdrConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsCdrConfiguration schema: 2.0.0 @@ -161,4 +161,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsCertificate.md b/skype/skype-ps/skype/Get-CsCertificate.md index 198dfbda65..99a8ec2704 100644 --- a/skype/skype-ps/skype/Get-CsCertificate.md +++ b/skype/skype-ps/skype/Get-CsCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscertificate +online version: https://learn.microsoft.com/powershell/module/skype/get-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsCertificate schema: 2.0.0 @@ -204,4 +204,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Request-CsCertificate](Request-CsCertificate.md) [Set-CsCertificate](Set-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Get-CsClientAccessLicense.md b/skype/skype-ps/skype/Get-CsClientAccessLicense.md index 38fc20c0b8..ca9a1a2205 100644 --- a/skype/skype-ps/skype/Get-CsClientAccessLicense.md +++ b/skype/skype-ps/skype/Get-CsClientAccessLicense.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientaccesslicense +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientaccesslicense applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientAccessLicense schema: 2.0.0 @@ -232,4 +232,3 @@ The Get-CsClientAccessLicense cmdlet returns licensing information. ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsClientCertificate.md b/skype/skype-ps/skype/Get-CsClientCertificate.md index 6775921162..396563d963 100644 --- a/skype/skype-ps/skype/Get-CsClientCertificate.md +++ b/skype/skype-ps/skype/Get-CsClientCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientcertificate +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientcertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientCertificate schema: 2.0.0 @@ -154,4 +154,3 @@ The cmdlet also accepts pipelined input of user objects. ## RELATED LINKS [Revoke-CsClientCertificate](Revoke-CsClientCertificate.md) - diff --git a/skype/skype-ps/skype/Get-CsClientPinInfo.md b/skype/skype-ps/skype/Get-CsClientPinInfo.md index d41082a872..58a1c53bdf 100644 --- a/skype/skype-ps/skype/Get-CsClientPinInfo.md +++ b/skype/skype-ps/skype/Get-CsClientPinInfo.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientpininfo +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpininfo applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientPinInfo schema: 2.0.0 @@ -157,4 +157,3 @@ The cmdlet also accepts pipelined input of user objects. [Set-CsClientPin](Set-CsClientPin.md) [Unlock-CsClientPin](Unlock-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Get-CsClientPolicy.md b/skype/skype-ps/skype/Get-CsClientPolicy.md index 9f2f7b6d2b..43174d771f 100644 --- a/skype/skype-ps/skype/Get-CsClientPolicy.md +++ b/skype/skype-ps/skype/Get-CsClientPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientPolicy schema: 2.0.0 manager: bulenteg @@ -201,4 +201,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientPolicy](Remove-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md b/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md index 1eb7ce2e7a..62a9a4f591 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientVersionConfiguration schema: 2.0.0 @@ -173,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md b/skype/skype-ps/skype/Get-CsClientVersionPolicy.md index a696e4b6fa..79e4188c89 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Get-CsClientVersionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientVersionPolicy schema: 2.0.0 @@ -198,4 +198,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md index ed1192d11a..88381a0d58 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClientVersionPolicyRule schema: 2.0.0 @@ -219,4 +219,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClientVersionPolicyRule](Remove-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md b/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md index 832d81310b..9908ff7acb 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md +++ b/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscloudcalldataconnector +online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnector applicable: Skype for Business Server 2019 title: Get-CsCloudCallDataConnector schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md index f7e08b8d35..2e03619361 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscloudcalldataconnectorconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 title: Get-CsCloudCallDataConnectorConfiguration schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md b/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md index 9e32dbe354..0cec065b8a 100644 --- a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md +++ b/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscloudmeetingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudmeetingpolicy applicable: Skype for Business Online title: Get-CsCloudMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsCloudMeetingPolicy diff --git a/skype/skype-ps/skype/Get-CsClsAgentStatus.md b/skype/skype-ps/skype/Get-CsClsAgentStatus.md index aac759a754..cf595df96b 100644 --- a/skype/skype-ps/skype/Get-CsClsAgentStatus.md +++ b/skype/skype-ps/skype/Get-CsClsAgentStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclsagentstatus +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsagentstatus applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClsAgentStatus schema: 2.0.0 @@ -98,4 +98,3 @@ Or an XmlDocument object if the DefaultXml parameter is used. ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsClsConfiguration.md b/skype/skype-ps/skype/Get-CsClsConfiguration.md index 7281bbbab5..d64818736f 100644 --- a/skype/skype-ps/skype/Get-CsClsConfiguration.md +++ b/skype/skype-ps/skype/Get-CsClsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClsConfiguration schema: 2.0.0 @@ -182,4 +182,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) [Set-CsClsConfiguration](Set-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsClsRegion.md b/skype/skype-ps/skype/Get-CsClsRegion.md index c409243968..2fbc717fd3 100644 --- a/skype/skype-ps/skype/Get-CsClsRegion.md +++ b/skype/skype-ps/skype/Get-CsClsRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclsregion +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClsRegion schema: 2.0.0 @@ -160,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClsRegion](Remove-CsClsRegion.md) [Set-CsClsRegion](Set-CsClsRegion.md) - diff --git a/skype/skype-ps/skype/Get-CsClsScenario.md b/skype/skype-ps/skype/Get-CsClsScenario.md index e5122159c4..b6d5b31459 100644 --- a/skype/skype-ps/skype/Get-CsClsScenario.md +++ b/skype/skype-ps/skype/Get-CsClsScenario.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClsScenario schema: 2.0.0 @@ -165,4 +165,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsClsSearchTerm.md b/skype/skype-ps/skype/Get-CsClsSearchTerm.md index 1b0891842a..df614416c4 100644 --- a/skype/skype-ps/skype/Get-CsClsSearchTerm.md +++ b/skype/skype-ps/skype/Get-CsClsSearchTerm.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclssearchterm +online version: https://learn.microsoft.com/powershell/module/skype/get-csclssearchterm applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClsSearchTerm schema: 2.0.0 @@ -168,4 +168,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsClsSearchTerm](Set-CsClsSearchTerm.md) - diff --git a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md b/skype/skype-ps/skype/Get-CsClsSecurityGroup.md index a1b96e55a2..7c79d2ab0a 100644 --- a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/Get-CsClsSecurityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skype/get-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsClsSecurityGroup schema: 2.0.0 @@ -160,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md b/skype/skype-ps/skype/Get-CsCommonAreaPhone.md index fe6b3b7ccb..97dc27f37a 100644 --- a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Get-CsCommonAreaPhone.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skype/get-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsCommonAreaPhone schema: 2.0.0 @@ -269,4 +269,3 @@ Represents the Identity of the common area phone. [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Get-CsComputer.md b/skype/skype-ps/skype/Get-CsComputer.md index d017fba976..295846eabe 100644 --- a/skype/skype-ps/skype/Get-CsComputer.md +++ b/skype/skype-ps/skype/Get-CsComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscomputer +online version: https://learn.microsoft.com/powershell/module/skype/get-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsComputer schema: 2.0.0 @@ -164,4 +164,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-CsComputer](Enable-CsComputer.md) [Test-CsComputer](Test-CsComputer.md) - diff --git a/skype/skype-ps/skype/Get-CsConferenceDirectory.md b/skype/skype-ps/skype/Get-CsConferenceDirectory.md index 25d83846c4..aaeb78a46a 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/Get-CsConferenceDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConferenceDirectory schema: 2.0.0 @@ -144,4 +144,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsConferenceDirectory](New-CsConferenceDirectory.md) [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) - diff --git a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md b/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md index dd4ec07886..6ce2b822e0 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md +++ b/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csconferencedisclaimer +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConferenceDisclaimer schema: 2.0.0 @@ -126,4 +126,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsConferenceDisclaimer](Remove-CsConferenceDisclaimer.md) [Set-CsConferenceDisclaimer](Set-CsConferenceDisclaimer.md) - diff --git a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md b/skype/skype-ps/skype/Get-CsConferencingConfiguration.md index 9bbfc33fee..381a5744ae 100644 --- a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConferencingConfiguration schema: 2.0.0 @@ -175,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsConferencingPolicy.md b/skype/skype-ps/skype/Get-CsConferencingPolicy.md index 05070d60da..570ad8b1b5 100644 --- a/skype/skype-ps/skype/Get-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Get-CsConferencingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csconferencingpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConferencingPolicy schema: 2.0.0 manager: bulenteg @@ -264,4 +264,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) [Get-CsConferencingPolicy](Get-CsConferencingPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md b/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md index dd73e9a00f..fdc95a47a5 100644 --- a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csconfigurationstorelocation +online version: https://learn.microsoft.com/powershell/module/skype/get-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConfigurationStoreLocation schema: 2.0.0 @@ -111,4 +111,3 @@ The Get-CsConfigurationStoreLocation cmdlet reports back the location of the con [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md b/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md index 137fca243a..8c4b36089d 100644 --- a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csconversationhistoryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsConversationHistoryConfiguration schema: 2.0.0 @@ -129,4 +129,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsConversationHistoryConfiguration](Remove-CsConversationHistoryConfiguration.md) [Set-CsConversationHistoryConfiguration](Set-CsConversationHistoryConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsCpsConfiguration.md b/skype/skype-ps/skype/Get-CsCpsConfiguration.md index 96de9c6a9e..2859c7b997 100644 --- a/skype/skype-ps/skype/Get-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/Get-CsCpsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsCpsConfiguration schema: 2.0.0 @@ -159,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsCpsConfiguration](Set-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - diff --git a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md b/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md index eb1626d850..ab7cc8b8ab 100644 --- a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md +++ b/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdatabasemirrorstate -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-csdatabasemirrorstate +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDatabaseMirrorState schema: 2.0.0 manager: rogupta @@ -173,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md index f69445587f..dcc4810931 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDeviceUpdateConfiguration schema: 2.0.0 @@ -166,4 +166,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md index fb4e0dae38..0e5442fdfb 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDeviceUpdateRule schema: 2.0.0 @@ -181,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md index 138e76de41..e828788cb7 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDiagnosticConfiguration schema: 2.0.0 @@ -173,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md index f3e74f578e..70f111e8de 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDiagnosticHeaderConfiguration schema: 2.0.0 @@ -181,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md index a002bff27d..fe50bf5290 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDialInConferencingAccessNumber schema: 2.0.0 @@ -329,4 +329,3 @@ The Get-CsDialInConferencingAccessNumber cmdlet accepts a string value represent [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md index 53a14f2cde..1a86bff077 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDialInConferencingConfiguration schema: 2.0.0 @@ -157,4 +157,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md index efdcc93ec6..7656e7a355 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDialInConferencingDtmfConfiguration schema: 2.0.0 @@ -162,4 +162,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md b/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md index 6e055957ed..1f82e950cc 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md +++ b/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdialinconferencinglanguagelist +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencinglanguagelist applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDialInConferencingLanguageList schema: 2.0.0 @@ -144,4 +144,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Get-CsDialPlan.md b/skype/skype-ps/skype/Get-CsDialPlan.md index 58fb23bd97..bd10f2446f 100644 --- a/skype/skype-ps/skype/Get-CsDialPlan.md +++ b/skype/skype-ps/skype/Get-CsDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csdialplan +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDialPlan schema: 2.0.0 @@ -187,4 +187,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Test-CsDialPlan](Test-CsDialPlan.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsEffectivePolicy.md b/skype/skype-ps/skype/Get-CsEffectivePolicy.md index 2b8582f3e8..117520586f 100644 --- a/skype/skype-ps/skype/Get-CsEffectivePolicy.md +++ b/skype/skype-ps/skype/Get-CsEffectivePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cseffectivepolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-cseffectivepolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsEffectivePolicy schema: 2.0.0 @@ -213,4 +213,3 @@ The cmdlet also accepts pipelined instances of the Active Directory user object. ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md index b680e2f691..36aa47f5ad 100644 --- a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csenhancedemergencyservicedisclaimer +online version: https://learn.microsoft.com/powershell/module/skype/get-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsEnhancedEmergencyServiceDisclaimer schema: 2.0.0 @@ -122,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsEnhancedEmergencyServiceDisclaimer](Set-CsEnhancedEmergencyServiceDisclaimer.md) [Get-CsLocationPolicy](Get-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsExUmContact.md b/skype/skype-ps/skype/Get-CsExUmContact.md index 06230805e7..e674e05256 100644 --- a/skype/skype-ps/skype/Get-CsExUmContact.md +++ b/skype/skype-ps/skype/Get-CsExUmContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skype/get-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsExUmContact schema: 2.0.0 @@ -238,4 +238,3 @@ Accepts a pipelined string value representing the Identity of an Exchange UM con [Set-CsExUmContact](Set-CsExUmContact.md) [Move-CsExUmContact](Move-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md index 43f428d5d1..5fa4d707b7 100644 --- a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csexternalaccesspolicy -applicable: Microsoft Teams, Skype for Business Online, Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalaccesspolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsExternalAccessPolicy schema: 2.0.0 author: tomkau @@ -40,24 +40,19 @@ That might be sufficient to meet your communication needs. If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. -(Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). -3. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. -4. -Communicate with people who have SIP accounts with a public instant messaging service such as Skype. +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. The Get-CsExternalAccessPolicy cmdlet provides a way for you to return information about all of the external access policies that have been configured for use in your organization. - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -68,7 +63,6 @@ Get-CsExternalAccessPolicy Example 1 returns a collection of all the external access policies configured for use in your organization. Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. - ### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" @@ -77,8 +71,6 @@ Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. Because access policy Identities must be unique, this command will never return more than one item. - - ### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond @@ -125,7 +117,6 @@ NOTE: The ApplicableTo parameter can only be used with Skype for Business Online NOTE: This command requires the Office 365 UsageLocation property to be configured for the user's Active Directory user account. - ## PARAMETERS ### -Identity @@ -157,18 +148,16 @@ Accept wildcard characters: False **Below Content Applies To:** Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 Enables you to do a wildcard search for external access policies. -For example, to find all the policies configured at the site scope, use this Filter: +For example, to find all the policies configured at the site scope, use this Filter: `site:*` -To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: +To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: `"S*".` Note that the Filter parameter can only be applied to the policy Identity. - - **Below Content Applies To:** Skype for Business Online Enables you to do a wildcard search for external access policies. @@ -182,8 +171,6 @@ To find the per-user policies Seattle, Seville, and Saskatoon (all of which star Note that the Filter parameter can only be applied to the policy Identity. - - ```yaml Type: String Parameter Sets: Filter, (All) @@ -277,20 +264,16 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy - ## NOTES - ## RELATED LINKS [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) diff --git a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md index 86bae7c2de..f3dc30cd98 100644 --- a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy applicable: Skype for Business Online title: Get-CsExternalUserCommunicationPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsExternalUserCommunicationPolicy @@ -142,10 +142,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps) +[New-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps) -[Set-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md b/skype/skype-ps/skype/Get-CsFIPSConfiguration.md index d675ebe1a3..4a4f0b69d7 100644 --- a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/Get-CsFIPSConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsFIPSConfiguration schema: 2.0.0 @@ -163,4 +163,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md index 8967cc0a0f..388bc6c94d 100644 --- a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsFileTransferFilterConfiguration schema: 2.0.0 @@ -174,4 +174,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsGraphPolicy.md b/skype/skype-ps/skype/Get-CsGraphPolicy.md index 4ee298aa3e..69cd22f5e8 100644 --- a/skype/skype-ps/skype/Get-CsGraphPolicy.md +++ b/skype/skype-ps/skype/Get-CsGraphPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csgraphpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csgraphpolicy applicable: Skype for Business Online title: Get-CsGraphPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsGraphPolicy @@ -122,4 +122,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Grant-CsGraphPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csgraphpolicy?view=skype-ps) +[Grant-CsGraphPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md index c2742d7cbc..199078925f 100644 --- a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skype/get-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsGroupPickupUserOrbit schema: 2.0.0 @@ -106,4 +106,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md index 0aff88f824..ce017ff110 100644 --- a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsHealthMonitoringConfiguration schema: 2.0.0 @@ -161,4 +161,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md index a331e7eaf6..7910736a0e 100644 --- a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsHostedVoicemailPolicy schema: 2.0.0 @@ -138,4 +138,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsHostedVoicemailPolicy](Set-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsHostingProvider.md b/skype/skype-ps/skype/Get-CsHostingProvider.md index 9e0f95ba5b..3e5f2a3e66 100644 --- a/skype/skype-ps/skype/Get-CsHostingProvider.md +++ b/skype/skype-ps/skype/Get-CsHostingProvider.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshostingprovider -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-cshostingprovider +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsHostingProvider schema: 2.0.0 manager: bulenteg @@ -187,4 +187,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsHuntGroup.md b/skype/skype-ps/skype/Get-CsHuntGroup.md deleted file mode 100644 index 27ffc2bac6..0000000000 --- a/skype/skype-ps/skype/Get-CsHuntGroup.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshuntgroup -applicable: Skype for Business Online -title: Get-CsHuntGroup -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsHuntGroup - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsCallQueue](Get-CsCallQueue.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Get-CsHuntGroupTenantInformation.md b/skype/skype-ps/skype/Get-CsHuntGroupTenantInformation.md deleted file mode 100644 index b0cea844af..0000000000 --- a/skype/skype-ps/skype/Get-CsHuntGroupTenantInformation.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshuntgrouptenantinformation -applicable: Skype for Business Online -title: Get-CsHuntGroupTenantInformation -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsHuntGroupTenantInformation - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. diff --git a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md index cf1ab93d84..4fe4251dd1 100644 --- a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsHybridApplicationEndpoint schema: 2.0.0 @@ -55,7 +55,7 @@ This example uses the Filter parameter to retrieve all the hybrid application en ### -Credential Enables you to run the Get-CsHybridApplicationEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects. -To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic. +To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential @@ -194,8 +194,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsHybridMediationServer.md b/skype/skype-ps/skype/Get-CsHybridMediationServer.md index 974cd928d1..22a1a60c23 100644 --- a/skype/skype-ps/skype/Get-CsHybridMediationServer.md +++ b/skype/skype-ps/skype/Get-CsHybridMediationServer.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshybridmediationserver +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridmediationserver applicable: Skype for Business Online title: Get-CsHybridMediationServer schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsHybridMediationServer diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md index 6c055b053f..35c6ae3de8 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnappliance applicable: Skype for Business Online title: Get-CsHybridPSTNAppliance schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsHybridPSTNAppliance @@ -181,8 +181,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsHybridPSTNAppliance](https://docs.microsoft.com/powershell/module/skype/set-cshybridpstnappliance?view=skype-ps) +[Set-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance?view=skype-ps) -[Register-CsHybridPSTNAppliance](https://docs.microsoft.com/powershell/module/skype/register-cshybridpstnappliance?view=skype-ps) +[Register-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance?view=skype-ps) -[Unregister-CsHybridPSTNAppliance](https://docs.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance?view=skype-ps) +[Unregister-CsHybridPSTNAppliance](https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md b/skype/skype-ps/skype/Get-CsHybridPSTNSite.md index e1d189c542..3bfc36476a 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Get-CsHybridPSTNSite.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnsite applicable: Skype for Business Online title: Get-CsHybridPSTNSite schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsHybridPSTNSite @@ -147,4 +147,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md b/skype/skype-ps/skype/Get-CsIPPhonePolicy.md index abd7d42aa1..7ae4ac2e57 100644 --- a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md +++ b/skype/skype-ps/skype/Get-CsIPPhonePolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csipphonepolicy -applicable: Skype for Business Online, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csipphonepolicy +applicable: Skype for Business Server 2019 title: Get-CsIPPhonePolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsIPPhonePolicy @@ -116,6 +116,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsIPPhonePolicy](https://docs.microsoft.com/powershell/module/skype/grant-csipphonepolicy?view=skype-ps) +[Grant-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy?view=skype-ps) -[Set-CsIPPhonePolicy](https://docs.microsoft.com/powershell/module/skype/set-csipphonepolicy?view=skype-ps) +[Set-CsIPPhonePolicy](https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsImConfiguration.md b/skype/skype-ps/skype/Get-CsImConfiguration.md index 652be83696..b174055e0f 100644 --- a/skype/skype-ps/skype/Get-CsImConfiguration.md +++ b/skype/skype-ps/skype/Get-CsImConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsImConfiguration schema: 2.0.0 @@ -122,8 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md b/skype/skype-ps/skype/Get-CsImFilterConfiguration.md index eb868a1e10..fec8ca39e9 100644 --- a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/Get-CsImFilterConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csimfilterconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csimfilterconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsImFilterConfiguration schema: 2.0.0 manager: bulenteg @@ -169,4 +169,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsImFilterConfiguration](Remove-CsImFilterConfiguration.md) [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md b/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md index 2a1467f531..4c07855098 100644 --- a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsImTranslationConfiguration schema: 2.0.0 @@ -100,4 +100,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md index ad6478ba07..769b89632e 100644 --- a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skype/get-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsKerberosAccountAssignment schema: 2.0.0 @@ -160,4 +160,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Get-CsLisCivicAddress.md b/skype/skype-ps/skype/Get-CsLisCivicAddress.md index d3edd240cf..c1fd4ffdb0 100644 --- a/skype/skype-ps/skype/Get-CsLisCivicAddress.md +++ b/skype/skype-ps/skype/Get-CsLisCivicAddress.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csliscivicaddress +online version: https://learn.microsoft.com/powershell/module/skype/get-csliscivicaddress applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisCivicAddress schema: 2.0.0 @@ -87,4 +87,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Test-CsLisCivicAddress](Test-CsLisCivicAddress.md) [Get-CsLisLocation](Get-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Get-CsLisLocation.md b/skype/skype-ps/skype/Get-CsLisLocation.md index 118b8e57a7..7b91277e0f 100644 --- a/skype/skype-ps/skype/Get-CsLisLocation.md +++ b/skype/skype-ps/skype/Get-CsLisLocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cslislocation +online version: https://learn.microsoft.com/powershell/module/skype/get-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisLocation schema: 2.0.0 @@ -104,4 +104,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsLisLocation](Set-CsLisLocation.md) [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Get-CsLisPort.md b/skype/skype-ps/skype/Get-CsLisPort.md index d179ac13e0..3eec392209 100644 --- a/skype/skype-ps/skype/Get-CsLisPort.md +++ b/skype/skype-ps/skype/Get-CsLisPort.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cslisport +online version: https://learn.microsoft.com/powershell/module/skype/get-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisPort schema: 2.0.0 @@ -80,4 +80,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisPort](Remove-CsLisPort.md) [Set-CsLisPort](Set-CsLisPort.md) - diff --git a/skype/skype-ps/skype/Get-CsLisServiceProvider.md b/skype/skype-ps/skype/Get-CsLisServiceProvider.md index e5656ec794..2efdc5c58d 100644 --- a/skype/skype-ps/skype/Get-CsLisServiceProvider.md +++ b/skype/skype-ps/skype/Get-CsLisServiceProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cslisserviceprovider +online version: https://learn.microsoft.com/powershell/module/skype/get-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisServiceProvider schema: 2.0.0 @@ -63,4 +63,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisServiceProvider](Remove-CsLisServiceProvider.md) [Set-CsLisServiceProvider](Set-CsLisServiceProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsLisSubnet.md b/skype/skype-ps/skype/Get-CsLisSubnet.md index ccb98a2b90..070908d63a 100644 --- a/skype/skype-ps/skype/Get-CsLisSubnet.md +++ b/skype/skype-ps/skype/Get-CsLisSubnet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cslissubnet +online version: https://learn.microsoft.com/powershell/module/skype/get-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisSubnet schema: 2.0.0 @@ -80,4 +80,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisSubnet](Remove-CsLisSubnet.md) [Set-CsLisSubnet](Set-CsLisSubnet.md) - diff --git a/skype/skype-ps/skype/Get-CsLisSwitch.md b/skype/skype-ps/skype/Get-CsLisSwitch.md index 1a8ad2aad3..b4fbab5b8d 100644 --- a/skype/skype-ps/skype/Get-CsLisSwitch.md +++ b/skype/skype-ps/skype/Get-CsLisSwitch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cslisswitch +online version: https://learn.microsoft.com/powershell/module/skype/get-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisSwitch schema: 2.0.0 @@ -91,4 +91,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisSwitch](Remove-CsLisSwitch.md) [Set-CsLisSwitch](Set-CsLisSwitch.md) - diff --git a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md b/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md index d9c6a1f2ed..469f7a2244 100644 --- a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/skype/get-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLisWirelessAccessPoint schema: 2.0.0 @@ -91,4 +91,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsLisWirelessAccessPoint](Remove-CsLisWirelessAccessPoint.md) [Set-CsLisWirelessAccessPoint](Set-CsLisWirelessAccessPoint.md) - diff --git a/skype/skype-ps/skype/Get-CsLocationPolicy.md b/skype/skype-ps/skype/Get-CsLocationPolicy.md index fa76512bfa..06e3d908b0 100644 --- a/skype/skype-ps/skype/Get-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Get-CsLocationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsLocationPolicy schema: 2.0.0 @@ -178,4 +178,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) [Test-CsLocationPolicy](Test-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsManagementConnection.md b/skype/skype-ps/skype/Get-CsManagementConnection.md index cc4108667c..be0b6e4a2d 100644 --- a/skype/skype-ps/skype/Get-CsManagementConnection.md +++ b/skype/skype-ps/skype/Get-CsManagementConnection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmanagementconnection +online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsManagementConnection schema: 2.0.0 @@ -82,4 +82,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsManagementConnection](Remove-CsManagementConnection.md) [Set-CsManagementConnection](Set-CsManagementConnection.md) - diff --git a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md b/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md index dd365e6590..a9c3ebe4b8 100644 --- a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md +++ b/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmanagementstorereplicationstatus +online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementstorereplicationstatus applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsManagementStoreReplicationStatus schema: 2.0.0 @@ -146,4 +146,3 @@ If the CentralManagementStoreStatus parameter is used, then the cmdlet returns i ## RELATED LINKS [Invoke-CsManagementStoreReplication](Invoke-CsManagementStoreReplication.md) - diff --git a/skype/skype-ps/skype/Get-CsMcxConfiguration.md b/skype/skype-ps/skype/Get-CsMcxConfiguration.md index bbff6fa655..8a44cb988e 100644 --- a/skype/skype-ps/skype/Get-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/Get-CsMcxConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmcxconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMcxConfiguration schema: 2.0.0 manager: rogupta @@ -177,4 +177,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsMediaConfiguration.md b/skype/skype-ps/skype/Get-CsMediaConfiguration.md index 5faee1ec16..226f87551c 100644 --- a/skype/skype-ps/skype/Get-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/Get-CsMediaConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMediaConfiguration schema: 2.0.0 @@ -151,4 +151,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsMediaConfiguration](Remove-CsMediaConfiguration.md) [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md b/skype/skype-ps/skype/Get-CsMeetingConfiguration.md index 17604ac40c..431f2547ca 100644 --- a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsMeetingConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmeetingconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMeetingConfiguration schema: 2.0.0 author: tomkau @@ -212,4 +212,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsMeetingConfiguration](Remove-CsMeetingConfiguration.md) [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsMeetingRoom.md b/skype/skype-ps/skype/Get-CsMeetingRoom.md index c5c4ffd7a3..4401dd0254 100644 --- a/skype/skype-ps/skype/Get-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Get-CsMeetingRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmeetingroom -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMeetingRoom schema: 2.0.0 manager: bulenteg @@ -251,4 +251,3 @@ The Get-CsMeetingRoom cmdlet accepts a pipelined string value representing the I [Move-CsMeetingRoom](Move-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - diff --git a/skype/skype-ps/skype/Get-CsMobilityPolicy.md b/skype/skype-ps/skype/Get-CsMobilityPolicy.md index 9fbeb7bbac..c59665485e 100644 --- a/skype/skype-ps/skype/Get-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Get-CsMobilityPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmobilitypolicy -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMobilityPolicy schema: 2.0.0 manager: bulenteg @@ -222,4 +222,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md index e3bb67dcbb..de1572dc01 100644 --- a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkBandwidthPolicyProfile schema: 2.0.0 @@ -137,4 +137,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkBandwidthPolicyProfile](Remove-CsNetworkBandwidthPolicyProfile.md) [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md b/skype/skype-ps/skype/Get-CsNetworkConfiguration.md index f0e67e070a..5914281385 100644 --- a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsNetworkConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkConfiguration schema: 2.0.0 manager: bulenteg @@ -158,4 +158,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md index 94ff58e532..c65e85e16f 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkInterRegionRoute schema: 2.0.0 @@ -151,4 +151,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkInterRegionRoute](Remove-CsNetworkInterRegionRoute.md) [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md index ad00407757..447ed6ca95 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkInterSitePolicy schema: 2.0.0 @@ -153,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkInterSitePolicy](Remove-CsNetworkInterSitePolicy.md) [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkInterface.md b/skype/skype-ps/skype/Get-CsNetworkInterface.md index d196803f0d..cce4863773 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterface.md +++ b/skype/skype-ps/skype/Get-CsNetworkInterface.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkinterface +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterface applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkInterface schema: 2.0.0 @@ -181,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsComputer](Get-CsComputer.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkRegion.md b/skype/skype-ps/skype/Get-CsNetworkRegion.md index d1e4f4c941..bac9faa045 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegion.md +++ b/skype/skype-ps/skype/Get-CsNetworkRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkRegion schema: 2.0.0 @@ -148,4 +148,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkRegion](Remove-CsNetworkRegion.md) [Set-CsNetworkRegion](Set-CsNetworkRegion.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md b/skype/skype-ps/skype/Get-CsNetworkRegionLink.md index 152773167c..9c7f1775f6 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/Get-CsNetworkRegionLink.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkRegionLink schema: 2.0.0 @@ -149,4 +149,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkRegionLink](Remove-CsNetworkRegionLink.md) [Set-CsNetworkRegionLink](Set-CsNetworkRegionLink.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkSite.md b/skype/skype-ps/skype/Get-CsNetworkSite.md index 3c0216e8b2..63eaeaaf8c 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSite.md +++ b/skype/skype-ps/skype/Get-CsNetworkSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkSite schema: 2.0.0 @@ -148,4 +148,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkSite](Remove-CsNetworkSite.md) [Set-CsNetworkSite](Set-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/Get-CsNetworkSubnet.md b/skype/skype-ps/skype/Get-CsNetworkSubnet.md index 1c91000ae2..aca38d63a4 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/Get-CsNetworkSubnet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsNetworkSubnet schema: 2.0.0 @@ -145,4 +145,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsNetworkSubnet](Remove-CsNetworkSubnet.md) [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) - diff --git a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md b/skype/skype-ps/skype/Get-CsOAuthConfiguration.md index 1878f73da4..b2c5cfbfdd 100644 --- a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md +++ b/skype/skype-ps/skype/Get-CsOAuthConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csoauthconfiguration -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsOAuthConfiguration schema: 2.0.0 manager: bulenteg @@ -156,4 +156,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsOAuthConfiguration](Set-CsOAuthConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsOAuthServer.md b/skype/skype-ps/skype/Get-CsOAuthServer.md index 26e05dc09b..d8186132f4 100644 --- a/skype/skype-ps/skype/Get-CsOAuthServer.md +++ b/skype/skype-ps/skype/Get-CsOAuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsOAuthServer schema: 2.0.0 @@ -165,4 +165,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsOAuthServer](Remove-CsOAuthServer.md) [Set-CsOAuthServer](Set-CsOAuthServer.md) - diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md deleted file mode 100644 index dce585e097..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint -applicable: Skype for Business Online -title: Get-CsOnlineApplicationEndpoint -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineApplicationEndpoint - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. This cmdlet will be removed in the near future. -> -> Please use the [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) cmdlet instead. - -It is used to fetch the application endpoints for a tenant. - -## SYNTAX - -``` -Get-CsOnlineApplicationEndpoint [-Uri] [-PhoneNumber ] [-Tenant ] - [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -This cmdlet is used to fetch the application endpoints for a tenant. - -## EXAMPLES - -### Example 1 -``` -Get-CsOnlineApplicationEndpoint -Uri "sip:sample@domain.com" -``` - -This example retrieves information about the specified application endpoint. - -## PARAMETERS - -### -Uri -Sip Uri that identifies the tenant specific endpoint for the application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The service number assigned to the trusted application endpoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/set-csonlineapplicationendpoint) - -[New-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint) - -[Remove-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://docs.microsoft.com/skype-sdk/trusted-application-api/docs/trustedapplicationendpoint) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md deleted file mode 100644 index d4238eebac..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationinstance -applicable: Skype for Business Online -title: Get-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineApplicationInstance - -## SYNOPSIS -Get application instance for the tenant from Azure Active Directory. - -## SYNTAX - -``` -Get-CsOnlineApplicationInstance [[-Identity] ] [[-ResultSize] ] [-Tenant ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet is used to get details of an application instance. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -```powershell -Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -``` - -This example returns the application instance with identity "appinstance01@contoso.com". - -### -------------------------- Example 2 -------------------------- -```powershell -Get-CsOnlineApplicationInstance -ResultSize 10 -``` - -This example returns the first 10 application instances. - -### -------------------------- Example 3 -------------------------- -```powershell -Get-CsOnlineApplicationInstance -``` - -This example returns the details of all application instances. - -## PARAMETERS - -### -Identity -The URI or the object ID of the application instance to retrieve. If this parameter is not provided, it will retrieve all application instances in the tenant. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The result size for bulk get. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -The Tenant ID. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserInfo.md b/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserInfo.md deleted file mode 100644 index 1ac3b343c1..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserInfo.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguserinfo -applicable: Skype for Business Online -title: Get-CsOnlineDialInConferencingUserInfo -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineDialInConferencingUserInfo - -## SYNOPSIS - -> [!NOTE] -> This cmdlet will be deprecated on December 31, 2021. To view the properties and settings of users that are enabled for Audio Conferencing, you can use the [Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) cmdlet. - -Use the `Get-CsOnlineDialInConferencingUserInfo` cmdlet to view the properties and settings of users that are enabled for dial-in conferencing and are using Microsoft or third-party provider as their PSTN conferencing provider. - -## SYNTAX - -### IdentityParams -``` -Get-CsOnlineDialInConferencingUserInfo [-Identity] [-DomainController ] [-Force] - [] -``` - -### TenantIdParams -``` -Get-CsOnlineDialInConferencingUserInfo [-Tenant ] [-Skip ] [-First ] - [-SearchQuery ] [-Select ] [-Filter ] [-SortDescending] - [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -This cmdlet will return users that have been enabled for audio conferencing using Microsoft or a third-party as the audio conferencing provider. If there are no users in the organization that have been enabled for audio conferencing, then the cmdlet will return no results. - -You can use [Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) cmdlet to return only users that have been enabled for audio conferencing using Microsoft as the audio conferencing provider. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDialInConferencingUserInfo -Filter {Provider -eq "InterCall"} -First 10 -``` - -This example returns users who have been enabled for audio conferencing provided by InterCall, but it will show only the first 10 users. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineDialInConferencingUserInfo -Select ConferencingProviderOther -``` - -This example returns users who have been enabled for audio conferencing provided by other than Microsoft. - -## PARAMETERS - -### -Identity -Specifies the user to retrieve. The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to limit the returned data by filtering on Skype for Business specific attributes. For example, you can limit returned data to users who have been assigned a specific third-party provider. - -The Filter parameter uses the same filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only users who have InterCall as Audio Conferencing Provider, with Provider representing the attribute, and -eq representing the comparison operator (equal to): - -{Provider -eq "InterCall"} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -First -When present, the cmdlet returns the first X number of users from the list of all the users enabled for dial-in conferencing. -If this parameter is not specified, the default behavior is to return the first 100 number of users. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchQuery -The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Select -Use next values to filter the output: -* DialInConferencingOn: Display all the users who are enabled for dial-in conferencing. -* DialInConferencingOff: Display all the users who are not enabled for dial-in conferencing. -* ConferencingProviderMS: Display all the users who are CPC enabled. -* ConferencingProviderOther: Display all the users who have 3rd party ACP. -* ReadyForMigrationToCPC: Display all the users who have 3rd party ACP and have been assigned a CPC license. -* NoFilter: Display all the users. - -```yaml -Type: FilterSelection -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Skip -Skips (does not select) the specified number of items. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortDescending -Indicates that the cmdlet sorts the objects in descending order. The default is ascending order. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 -[Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserState.md b/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserState.md deleted file mode 100644 index 952b957792..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUserState.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguserstate -applicable: Skype for Business Online -title: Get-CsOnlineDialInConferencingUserState -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineDialInConferencingUserState - -## SYNOPSIS - -> [!NOTE] -> This cmdlet will be deprecated on December 31, 2021. To view the properties and settings of users that are enabled for Audio Conferencing, you can use the [Get-CsOnlineDialInConferencingUser](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) cmdlet. - -Use the `Get-CsOnlineDialInConferencingUserState` cmdlet to view the current Dial In Conferencing state of users in your Tenant. - -## SYNTAX - -``` -Get-CsOnlineDialInConferencingUserState [[-Identity] ] [-Tenant ] - [-TenantDomain ] [-Provider ] [-LicenseState ] - [-ResultSize ] [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -Use the `Get-CsOnlineDialInConferencingUserState` cmdlet to view the current Dial In Conferencing state of users in your Tenant. - -## EXAMPLES - -### Example 1 -``` -Get-CsOnlineDialInConferencingUserState -``` -Gets the Dial In Conferencing state of every user. - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the user to retrieve. The user can be specified by using the user's SIP address, the user's user principal name (UPN) or the user's display name (for example, Ken Myer). - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -LicenseState -License state of the user, possible values -- NoLicense -- Licensed - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -Audio Conferencing Provider name, possible values -- AllProviders -- NoProviders -- Microsoft -- ThirdParty - -```yaml -Type: ProviderType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -PARAMVALUE: Unlimited - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TenantDomain -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md b/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md deleted file mode 100644 index 1dfbed5093..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedirectorytenantnumbercities -applicable: Skype for Business Online -title: Get-CsOnlineDirectoryTenantNumberCities -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineDirectoryTenantNumberCities - -## SYNOPSIS -Use the Get-CsOnlineDirectoryTenantNumberCities cmdlet to retrieve the cities for which telephone numbers have been acquired by your organization. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineDirectoryTenantNumberCities [[-Tenant] ] [-DomainController ] [-Force] - [] -``` - -## DESCRIPTION -This cmdlet can be used to fetch all the cities for which your organization has already acquired telephone numbers. -It is mainly used to filter cities for which telephone numbers are acquired. - -The console output will be in the form: - -Get-CsOnlineDirectoryTenantNumberCities - -NOAM-US-CA-LA - -NOAM-US-IL-CH - -NOAM-US-NY-NY - -NOAM-US-TX-DA - -NOAM-US-MA-BO - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineDirectoryTenantNumberCities -``` - -This example returns all the cities for which telephone numbers have been acquired by your organization. - - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### IList containing the geocodes of the relevant cities. - - -## NOTES - - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md deleted file mode 100644 index 2658bca491..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinenumberportinorder -applicable: Skype for Business Online -title: Get-CsOnlineNumberPortInOrder -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -Get-CsOnlineNumberPortInOrder [-Tenant ] [-PortInOrderId ] [-DomainController ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - -## PARAMETERS - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortInOrderId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md b/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md deleted file mode 100644 index e058d4770c..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinenumberportoutorderpin -applicable: Skype for Business Online -title: Get-CsOnlineNumberPortOutOrderPin -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineNumberPortOutOrderPin - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. - -## SYNTAX - -``` -Get-CsOnlineNumberPortOutOrderPin [-Tenant ] [-DomainController ] [-Force] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet is reserved for Microsoft internal use only. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -{{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md deleted file mode 100644 index 3b523522d4..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberavailablecount -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberAvailableCount -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberAvailableCount - -## SYNOPSIS -Use the Get-CsOnlineTelephoneNumberAvailableCount cmdlet to retrieve the total telephone numbers your organization is licensed to acquire. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX -``` -Get-CsOnlineTelephoneNumberAvailableCount [[-Tenant] ] [-InventoryType ] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The console output of this cmdlet will be in the form: - -Get-CsOnlineTelephoneNumberAvailableCount - -RunspaceId Count - -------------- ------ - -37c11bb0-3064-4e36-a0af-05efe9ee2bd3 11010 - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberAvailableCount -``` - -This example returns the total telephone numbers your organization is licensed to acquire. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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 - -### LacAvailableNumberCount object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md deleted file mode 100644 index c3ab7f80a2..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberinventoryareas -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryAreas -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberInventoryAreas - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryAreas` cmdlet to retrieve the geographical areas where specified inventory types are supported. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryAreas [-Tenant ] -RegionalGroup - -CountryOrRegion [-Area ] -InventoryType [-DomainController ] [-Force] - [] -``` - -## DESCRIPTION -Following is an example of the console output for the Get-CsOnlineTelephoneNumberInventoryAreas cmdlet. - -Get-CsOnlineTelephoneNumberInventoryAreas -InventoryType Subscriber -RegionalGroup NOAM -CountryOrRegion US - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : IL - -DefaultName : Illinois - -Cities : {} - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : MA - -DefaultName : Massachusetts - -Cities : {} - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : NY - -DefaultName : New York - -Cities : {} - -RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d - -Id : OR - -DefaultName : Oregon - -Cities : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryAreas -InventoryType Subscriber -RegionalGroup NOAM -CountryOrRegion US -``` - -This example returns the areas with Subscriber inventory in the specified region and country. - - -## PARAMETERS - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.InventoryArea -Instance or array of the objects. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md deleted file mode 100644 index 2fd49748e6..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberinventorycities -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryCities -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberInventoryCities - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryCities` to retrieve the cities that support a given inventory type within a geographical area. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryCities [-Tenant ] -RegionalGroup - -CountryOrRegion -Area [-CapitalOrMajorCity ] -InventoryType - [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -Following is an example of the `Get-CsOnlineTelephoneNumberInventoryCities` cmdlet's console output. - -Get-CsOnlineTelephoneNumberInventoryCities -InventoryType Service -RegionalGroup NOAM -CountryOrRegion US -Area NY - -RunspaceId : 1374aa93-75c4-4679-b765-6efc22f97563 - -Id : NY - -DefaultName : New York City - -GeoCode : NOAM-US-NY-NY - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryCities -InventoryType Service -RegionalGroup NOAM -CountryOrRegion US -Area NY -``` - -The following example retrieves the cities defined as supporting "Service" inventory types in New York state. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryCities -InventoryType Subscriber -RegionalGroup NOAM -CountryOrRegion US -Area NY -``` - -The following example retrieves the cities defined as supporting "Subscriber" inventory types in New York state. - - -## PARAMETERS - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -Specifies the target geographical city for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: City -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.InventoryCity -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md deleted file mode 100644 index e20ccab207..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberinventorycountries -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryCountries -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberInventoryCountries - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryCountries` cmdlet to retrieve a list of countries with telephone number inventories by specified region and telephone number inventory types. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryCountries [-Tenant ] -RegionalGroup - [-CountryOrRegion ] -InventoryType [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -Following is an example of the `Get-CsOnlineTelephoneNumberInventoryCountries` cmdlet's console output. - -RunspaceId : af39ca40-06a7-473b-8963-668865d15e87 - -Id : US - -DefaultName : United States - -Areas : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryCountries -InventoryType Service -RegionalGroup NOAM -``` - -This example returns the countries in the north American region that contain service type telephone numbers. - -## PARAMETERS - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Country -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md deleted file mode 100644 index 4199cff5e7..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberinventoryregions -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryRegions -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberInventoryRegions - -## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberInventoryRegions` cmdlet to retrieve the regions where specified inventory types are supported. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryRegions [-Tenant ] [-RegionalGroup ] - -InventoryType [-DomainController ] [-Force] [] -``` - -## DESCRIPTION -Following is an example of the `Get-CsOnlineTelephoneNumberInventoryRegions` cmdlet's console output. - -RunspaceId : f90303a9-c6a8-483c-b3b3-a5b8cdbab19c - -Id : NOAM - -DefaultName : North America - -Countries : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryRegions -InventoryType Service -``` - -This example returns the region where the inventory type of "Service" is supported. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryRegions -InventoryType Subscriber -``` - -This example returns the region where the inventory type of "Subscriber" is supported. - -## PARAMETERS - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Region -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md deleted file mode 100644 index 81a0c70f1b..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberinventorytypes -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberInventoryTypes -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberInventoryTypes - -## SYNOPSIS -Use the Get-CsOnlineTelephoneNumberInventoryTypes cmdlet to retrieve the telephone number inventory types that are defined. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberInventoryTypes [-Tenant ] [-DomainController ] [-Force] - [] -``` - -## DESCRIPTION -This is an example of Get-CsOnlineTelephoneNumberInventoryTypes cmdlet's console output. - -RunspaceId : af39ca40-06a7-473b-8963-668865d15e87 - -Id : Service - -Description : Inventory of service telephone numbers - -Regions : {} - -Reservations : {} - -RunspaceId : af39ca40-06a7-473b-8963-668865d15e87 - -Id : Subscriber - -Description : Inventory of subscriber telephone numbers - -Regions : {} - -Reservations : {} - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberInventoryTypes -``` - -This example retrieves all the telephone number types for your organization. - - -## PARAMETERS - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Deserialized.Microsoft.Skype.EnterpriseVoice.BVDClient.Inventory -Instance or array of the object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md b/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md deleted file mode 100644 index e94f24f364..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinetelephonenumberreservationsinformation -applicable: Skype for Business Online -title: Get-CsOnlineTelephoneNumberReservationsInformation -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineTelephoneNumberReservationsInformation - -## SYNOPSIS -Use the Get-CsOnlineTelephoneNumberReservationsInformation to retrieve information about the total number of telephone numbers which can reserved per session, and the maximum active reservations per session. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Get-CsOnlineTelephoneNumberReservationsInformation [-Tenant ] [-DomainController ] [-Force] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet is used to see the number of active reservations, reserved telephone numbers, maximum reservations supported per session, and maximum telephone numbers that can be reserved per session. - -The console output of this cmdlet will be in the following form: - -Get-CsOnlineTelephoneNumberReservationsInformation - -RunspaceId : 37c11bb0-3064-4e36-a0af-05efe9ee2bd3 - -ActiveReservationsCount : 0 - -ActiveReservedNumbersCount : 0 - -MaximumActiveReservationsCount : 10 - -MaximumActiveReservedNumbersCount : 200 - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineTelephoneNumberReservationsInformation -``` - -This example returns the number of active reservations, reserved telephone numbers, maximum reservations supported per session, and maximum telephone numbers that can be reserved per session. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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 - -### LacReservationInformation object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineUser.md b/skype/skype-ps/skype/Get-CsOnlineUser.md deleted file mode 100644 index ca4870daf3..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ /dev/null @@ -1,633 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineuser -applicable: Microsoft Teams, Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOnlineUser - -## SYNOPSIS -Returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. - -## SYNTAX - -``` -Get-CsOnlineUser [[-Identity] ] - [-AccountType ] - [-Credential ] - [-DomainController ] - [-Filter ] - [-LdapFilter ] - [-OnModernServer] - [-OnOfficeCommunicationServer] - [-OU ] - [-ResultSize ] - [-SkipUserPolicies] - [-UnassignedUser] - [-UsePreferredDC] - [] -``` - -## DESCRIPTION -The Get-CsOnlineUser cmdlet returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. -The returned information includes standard Active Directory account information (such as the department the user works in, his or her address and phone number, etc.) as well as Skype for Business Server 2015 specific information: the Get-CsOnlineUser cmdlet returns information about such things as whether or not the user has been enabled for Enterprise Voice and which per-user policies (if any) have been assigned to the user. - -Note that the Get-CsOnlineUser cmdlet does not have a TenantId parameter; that means you cannot use a command similar to this in order to limit the returned data to users who have accounts with a specific Microsoft Teams or Skype for Business Online tenant: - -`Get-CsOnlineUser -TenantId "bf19b7db-6960-41e5-a139-2aa373474354"` - -However, if you have multiple you can return users from a specified tenant by using the Filter parameter and a command similar to this: - -`Get-CsOnlineUser -Filter "TenantId -eq 'bf19b7db-6960-41e5-a139-2aa373474354'"` - -That command will limit the returned data to user accounts belong to the tenant with the TenantId "bf19b7db-6960-41e5-a139-2aa373474354". -If you do not know your tenant IDs you can return that information by using this command: - -`Get-CsTenant` - -If you have a hybrid or "split domain" deployment (that is, a deployment in which some users have accounts homed on Skype for Business Online while other users have accounts homed on an on-premises version of Skype for Business Server 2015) keep in mind that the Get-CsOnlineUser cmdlet only returns information for Skype for Business Online users. -However, the cmdlet will return information for both online users and on-premises users. -If you want to exclude Skype for Business Online users from the data returned by the Get-CsUser cmdlet, use the following command: - -`Get-CsUser -Filter "TenantId -eq '00000000-0000-0000-0000-000000000000'"` - -By definition, users homed on the on-premises version will always have a TenantId equal to 00000000-0000-0000-0000-000000000000. -Users homed on Skype for Business Online will a TenantId that is equal to some value other than 00000000-0000-0000-0000-000000000000. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsOnlineUser -``` - -The command shown in Example 1 returns information for all the users configured as online users. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" -``` - -In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". - -### -------------------------- Example 3 -------------------------- -``` -Get-CsOnlineUser -Filter "ArchivingPolicy -eq 'RedmondArchiving'" -``` - -Example 3 uses the Filter parameter to limit the returned data to online users who have been assigned the per-user archiving policy RedmondArchiving. - -To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". - -### -------------------------- Example 4 -------------------------- -``` -Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} -``` - -Example 4 returns information only for user accounts that have been configured so that the account does not appear in Microsoft Exchange address lists. - -(That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. - -### -------------------------- Example 5 -------------------------- -``` -Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} -Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} -Get-CsOnlineUser -Filter {LineURI -eq "1234"} -``` -Example 5 returns information for user accounts that have been assigned a designated phone number. - -### -------------------------- Example 6 -------------------------- -``` -Get-CsOnlineUser -AccountType ResourceAccount -``` -Example 6 returns information for user accounts that are categorized as resource accounts. - -## PARAMETERS - -### -AccountType -This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate the user type. The possible values for the AccountType parameter are: -- `User` - to query for user accounts. -- `ResourceAccount` - to query for app endpoints or resource accounts. -- `Guest` - to query for guest accounts. -- `Unknown` - to query for a user type that is not known. - - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the user account to be retrieved. - -For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account (note that these changes are currently only rolled out in commercial environments and are currently **not** applicable to government environments): - - -- GUID -- SIP address -- UPN -- Alias - -Using the Teams PowerShell Module version 2.6 or earlier only, you can use the following values to identify the account: - -- GUID -- SIP address -- UPN -- Alias -- Display name. Supports the asterisk ( \* ) wildcard character. For example, `-Identity "* Smith"` returns all the users whose display names end with Smith. - -Using the the Teams PowerShell Module version version 2.5.1 or later, the the Get-CsOnlineUser command no longer includes deprecated properties in the output. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later as it is no longer relevant to Microsoft Teams. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later as it is no longer relevant to Microsoft Teams. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. - -The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. - -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later: - -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes (note that these changes are currently only rolled out in commercial environments and are currently **not** applicable to government environments): - -- AccountType -- accountEnabled -- AssignedPlan -- Company -- Country -- department -- displayName -- EnterpriseVoiceEnabled -- ExternalAccessPolicy -- givenName -- Identity -- IsSipEnabled -- lineUri -- userPrincipalName -- CallingLineIdentity -- OnlineAudioConferencingRoutingPolicy -- OnlineDialOutPolicy -- OnlineVoicemailPolicy -- OnlineVoiceRoutingPolicy -- ownerUrn -- TeamsAppPermissionPolicy -- TeamsAppSetupPolicy -- TeamsAudioConferencingPolicy -- TeamsCallHoldPolicy -- TeamsCallingPolicy -- TeamsCallParkPolicy -- TeamsChannelsPolicy -- TeamsComplianceRecordingPolicy -- TeamsCortanaPolicy -- TeamsEducationAssignmentsAppPolicy -- TeamsEmergencyCallingPolicy -- TeamsEmergencyCallRoutingPolicy -- TeamsFeedbackPolicy -- TeamsIPPhonePolicy -- TeamsMeetingBrandingPolicy -- TeamsMeetingBroadcastPolicy -- TeamsMeetingPolicy -- TeamsMessagingPolicy -- TeamsMobilityPolicy -- TeamsNotificationAndFeedsPolicy -- TeamsShiftsAppPolicy -- TeamsShiftsPolicy -- TeamsSurvivableBranchAppliancePolicy -- TeamsSyntheticAutomatedCallPolicy -- TeamsTargetingPolicy -- TeamsTemplatePermissionPolicy -- TeamsUpdateManagementPolicy -- TeamsUpgradeOverridePolicy -- TeamsUpgradePolicy -- TeamsVdiPolicy -- TeamsVerticalPackagePolicy -- TeamsVideoInteropServicePolicy -- TenantDialPlan -- Title -- UsageLocation -- UserDirSyncEnabled -- TeamsWorkLoadPolicy -- VoiceRoutingPolicy -- LastName (available in Teams PowerShell Module 4.2.1 and later) - -*Attributes that have changed in meaning/format*: - -**OnPremLineURI**: This attribute previously used to refer to both: - -1. LineURI set via OnPrem AD. -2. Direct Routing numbers assigned to users via Set-CsUser. - -In Teams PowerShell Module version 3.0.0 and later, the **OnPremLineURI** attribute refers only to the LineURI that's set via OnPrem AD. Previously, **OnPremLineURI** also referred to Direct Routing numbers that were assigned to users via the Set-CsUser cmdlet. OnPremLineUriManuallySet is now deprecated as OnPremLineURI is representative of the On-Prem assignment. Also, Direct Routing numbers are available in the **LineURI** attribute. You can distinguish Direct Routing Numbers from Calling Plan Numbers by looking at the **FeatureTypes** attribute. - -In the Teams PowerShell Module version 3.0.0 or later, the format of the AssignedPlan and ProvisionedPlan attributes has changed from XML to JSON array. Previous XML filters (For example, `-Filter "AssignedPlan -eq ''"`) will no longer work. Instead, you need to update your filters to use one of the following formats: - -- All users with an AssignedPlan that matches MCO: `-Filter "AssignedPlan -eq 'MCO'"` -- All users with an AssignedPlan that starts with MCO: `-Filter "AssignedPlan -like 'MCO*'"` -- All users with an AssignedPlan that contains MCO: `-Filter "AssignedPlan -like '*MCO*'"` -- All users with an AssignedPlan that ends with "MCO": `-Filter "AssignedPlan -like '*MCO'"` - -**Policy Attributes**: - -- PolicyProperty comparison works only when "Authority" is provided in the value. For ex: `-Filter "TeamsMessagingPolicy -eq ':'"` -"Authority" can contain any of these two values: Host or Tenant for a policy type (configurations that are provided by default are referred to as Host configurations while admin-created configurations are considered Tenant configurations). The following are more examples: - -- Filter "TeamsMessagingPolicy -eq 'Host:EduStudent'" -- Filter "TeamsMessagingPolicy -eq 'Tenant:TestDemoPolicy'" - -- In the Teams PowerShell Module version 3.0.0 or later, the output format of Policies has now changed from String to JSON type UserPolicyDefinition. - -- Filtering for null policies: Admins can query for users that do not have any policies assigned (null policies) by including an empty value in the query, for example, Get-csonlineuser -filter "TeamsMeetingBroadcastPolicy -eq ' ' " - -*Change in Filter operators*: - -The following filter syntaxes have been modified in Teams PowerShell Module 3.0.0 and later: - -- -not, -lt, -gt: These operators have been dropped. -- -ge: This operator is not supported with policy properties. -- -like: This operator is supported only with wildcard character in the end (e.g., `"like *"`). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LdapFilter -This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later as it is no longer relevant to Microsoft Teams. - -Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Microsoft Teams or Skype for Business). For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. - -The LdapFilter parameter uses the LDAP query language when creating filters. The LDAP filter syntax is ``. The following example returns only users who work in the city of Redmond (their `locality` attribute value is `Redmond`): `-LdapFilter "l=Redmond"`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnModernServer -This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later due to limited usage. - -When present, the cmdlet returns a collection of users homed on Microsoft Teams or Skype for Business. Users with accounts on previous versions of the software will not be returned when you use this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: OnLyncServer -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnOfficeCommunicationServer -TThis parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later as it is no longer relevant to Microsoft Teams. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OU -This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later as it is no longer relevant to Microsoft Teams. - -```yaml -Type: OUIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize - -**Note**: Starting with Teams PowerShell Modules version 4.0 and later, "-ResultSize" type has been changed to uint32. - -Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. - -The result size can be set to any whole number between 0 and 2147483647, inclusive. The value 0 returns no data. If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipUserPolicies -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnassignedUser -This parameter has been deprecated from the Teams PowerShell Modules version 3.0 or later due to limited usage. - -Enables you to return a collection of all the users who have been enabled for Skype for Business but are not currently assigned to a Registrar pool. -Users are not allowed to log on to unless they are assigned to a Registrar pool. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsePreferredDC - -Reserved for Microsoft internal use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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). - -## OUTPUTS - -### Notes - -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later (note that these changes are currently only rolled out in commercial environments and are currently **not** applicable to government environments): - -*New user attributes*: - -FeatureTypes – Array of unique strings specifying what features are enabled for a user. This attribute is an alternatitive to several attributes that have been dropped as outlined in the next section. -Some of the commonly used FeatureTypes include: - -- Teams -- AudioConferencing -- PhoneSystem -- CallingPlan - -AccountEnabled: Indicates whether a user is enabled for login in Azure AD. - -*Dropped attributes*: - -The following attributes are no longer relevant to Teams and have been dropped from the output: - -- AcpInfo -- AdminDescription -- ArchivingPolicy -- AudioVideoDisabled -- BaseSimpleUrl -- BroadcastMeetingPolicy -- CallViaWorkPolicy -- ClientPolicy -- ClientUpdateOverridePolicy -- ClientVersionPolicy -- CloudMeetingOpsPolicy -- CloudMeetingPolicy -- CloudVideoInteropPolicy -- ContactOptionFlags -- CountryOrRegionDisplayName -- Description -- DistinguishedName -- EnabledForRichPresence -- ExchangeArchivingPolicy -- ExchUserHoldPolicies -- ExperiencePolicy -- ExternalUserCommunicationPolicy -- ExUmEnabled -- Guid -- HomeServer -- HostedVoicemailPolicy -- IPPBXSoftPhoneRoutingEnabled -- IPPhone -- IPPhonePolicy -- IsByPassValidation -- IsValid -- LegalInterceptPolicy -- LicenseRemovalTimestamp -- LineServerURI -- Manager -- MNCReady -- Name -- NonPrimaryResource -- ObjectCategory -- ObjectClass -- ObjectState -- OnPremHideFromAddressLists -- OriginalPreferredDataLocation -- OriginatingServer -- OriginatorSid -- OverridePreferredDataLocation -- PendingDeletion -- PrivateLine -- ProvisioningCounter -- ProvisioningStamp -- PublishingCounter -- PublishingStamp -- Puid -- RemoteCallControlTelephonyEnabled -- RemoteMachine -- SamAccountName -- ServiceInfo -- StsRefreshTokensValidFrom -- SubProvisioningCounter -- SubProvisioningStamp -- SubProvisionLineType -- SyncingCounter -- TargetRegistrarPool -- TargetServerIfMoving -- TeamsInteropPolicy -- ThumbnailPhoto -- UpgradeRetryCounter -- UserAccountControl -- UserProvisionType -- UserRoutingGroupId -- VoicePolicy - Alternative is the CallingPlan and PhoneSystem string in FeatureTypes -- XForestMovePolicy -- AddressBookPolicy -- GraphPolicy -- PinPolicy -- PreferredDataLocationOverwritePolicy -- PresencePolicy -- SmsServicePolicy -- TeamsVoiceRoute -- ThirdPartyVideoSystemPolicy -- UserServicesPolicy -- ConferencingPolicy -- Id -- MobilityPolicy -- OnlineDialinConferencingPolicy - Alternative is the AudioConferencing string in FeatureTypes -- Sid -- TeamsWorkLoadPolicy -- VoiceRoutingPolicy -- ClientUpdatePolicy -- HomePhone -- HostedVoiceMail -- MobilePhone -- OtherTelephone -- StreetAddress -- WebPage -- AssignedLicenses -- OnPremisesUserPrincipalName -- HostedVoiceMail -- LicenseAssignmentStates -- OnPremDomainName -- OnPremSecurityIdentifier -- OnPremSamAccountName -- CallerIdPolicy -- Fax -- LastName (available in Teams PowerShell Module 4.2.1 and later) -- Office -- Phone -- WindowsEmailAddress -- SoftDeletedUsers (available in Teams PowerShell Module 4.4.3 and later) - - -The following attributes are temporarily unavailable in the output when using the "-Filter" or when used without the "-Identity" parameter: -- WhenChanged -- CountryAbbreviation - -**Note**: These attributes will be available in the near future. - -*Attributes renamed*: - -- ObjectId renamed to Identity -- FirstName renamed to GivenName -- DirSyncEnabled renamed to UserDirSyncEnabled -- MCOValidationErrors renamed to UserValidationErrors -- Enabled renamed to IsSipEnabled -- TeamsBranchSurvivabilityPolicy renamed to TeamsSurvivableBranchAppliancePolicy -- CountryOrRegionDisplayName introduced as Country (in versions 4.2.0 and later) -- InterpretedUserType: "AADConnectEnabledOnline" prefix for the InterpretedUserType output value has now been renamed DirSyncEnabledOnline, for example, AADConnectEnabledOnlineTeamsOnlyUser is now DirSyncEnabledOnlineTeamsOnlyUser. - -*Attributes that have changed in meaning/format*: - -**OnPremLineURI**: This attribute previously used to refer to both: - -1. LineURI set via OnPrem AD. -2. Direct Routing numbers assigned to users via Set-CsUser. - -In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the LineURI set via OnPrem AD. Direct Routing numbers will be available from the LineURI field. Direct Routing Numbers can be distinguished from Calling Plan Numbers by looking at the FeatureTypes attribute. - -- **The output format of AssignedPlan and ProvisionedPlan have now changed from XML to JSON array.** -- **The output format of Policies has now changed from String to JSON type UserPolicyDefinition.** - -## INPUTS - -## NOTES -- The changes mentioned under the "-Identity" and "-Filter" sections are not applicable to customers and tenants that are or have previously been enabled for Regionally Hosted Meetings for Skype for Business Online. -- These changes are currently only rolled out in commercial environments and are **not** applicable to government environments. - -## RELATED LINKS - -[Set-CsUser](Set-CsUser.md) diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md deleted file mode 100644 index fab4d1aa1c..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csorganizationalautoattendant -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendant -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOrganizationalAutoAttendant - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendant](Get-CsAutoAttendant.md) cmdlet instead. - diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index 3c56edb4d7..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csorganizationalautoattendantholidays -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOrganizationalAutoAttendantHolidays - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantStatus.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantStatus.md deleted file mode 100644 index 02295615e7..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantStatus.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csorganizationalautoattendantstatus -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantStatus -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOrganizationalAutoAttendantStatus - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md deleted file mode 100644 index 91243bc942..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csorganizationalautoattendantsupportedlanguage -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantSupportedLanguage -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOrganizationalAutoAttendantSupportedLanguage - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md deleted file mode 100644 index c073381a46..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csorganizationalautoattendantsupportedtimezone -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantSupportedTimeZone -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOrganizationalAutoAttendantSupportedTimeZone - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md b/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md deleted file mode 100644 index de8f804617..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csorganizationalautoattendanttenantinformation -applicable: Skype for Business Online -title: Get-CsOrganizationalAutoAttendantTenantInformation -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsOrganizationalAutoAttendantTenantInformation - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md index 290ef15bc9..5583f31ca1 100644 --- a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsOutboundCallingNumberTranslationRule schema: 2.0.0 @@ -168,4 +168,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md b/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md index aa6c536ca6..8b9c66c91c 100644 --- a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsOutboundTranslationRule schema: 2.0.0 @@ -143,4 +143,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsPartnerApplication.md b/skype/skype-ps/skype/Get-CsPartnerApplication.md index 9f955c1ce1..d88eef5d7f 100644 --- a/skype/skype-ps/skype/Get-CsPartnerApplication.md +++ b/skype/skype-ps/skype/Get-CsPartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skype/get-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPartnerApplication schema: 2.0.0 @@ -186,4 +186,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) [Set-CsPartnerApplication](Set-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md b/skype/skype-ps/skype/Get-CsPersistentChatAddin.md index 508ca174d1..72d85cb632 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatAddin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchataddin +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatAddin schema: 2.0.0 manager: rogupta @@ -137,4 +137,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md b/skype/skype-ps/skype/Get-CsPersistentChatCategory.md index df640c38fa..e00444b74c 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcategory +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatCategory schema: 2.0.0 manager: rogupta @@ -161,4 +161,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md index 7b34e77a4c..cf19471a4f 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcomplianceconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta @@ -180,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md index 828f205213..7fd56a3f4c 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta @@ -179,4 +179,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md b/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md index 8582982224..f4405e37b0 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchateligibleprincipal -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchateligibleprincipal +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatEligiblePrincipal schema: 2.0.0 manager: rogupta @@ -213,4 +213,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md index 9b55800af6..04e98b3f03 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatendpoint -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatendpoint +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatEndpoint schema: 2.0.0 manager: rogupta @@ -248,4 +248,3 @@ String value representing the Identity or the SIP address of a Persistent Chat e [New-CsPersistentChatEndpoint](New-CsPersistentChatEndpoint.md) [Remove-CsPersistentChatEndpoint](Remove-CsPersistentChatEndpoint.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md index 06e6d675b2..7c0e9ecc89 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta @@ -198,4 +198,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md b/skype/skype-ps/skype/Get-CsPersistentChatRoom.md index 124a06ce57..b2f79623d0 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatRoom schema: 2.0.0 manager: rogupta @@ -390,4 +390,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Get-CsPersistentChatState.md b/skype/skype-ps/skype/Get-CsPersistentChatState.md index b673d18955..232ca51c32 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatState.md +++ b/skype/skype-ps/skype/Get-CsPersistentChatState.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspersistentchatstate -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatstate +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatState schema: 2.0.0 manager: rogupta @@ -152,4 +152,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsPersistentChatState](Set-CsPersistentChatState.md) - diff --git a/skype/skype-ps/skype/Get-CsPinPolicy.md b/skype/skype-ps/skype/Get-CsPinPolicy.md index b9d175534b..a72edbf43e 100644 --- a/skype/skype-ps/skype/Get-CsPinPolicy.md +++ b/skype/skype-ps/skype/Get-CsPinPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPinPolicy schema: 2.0.0 @@ -202,4 +202,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPinPolicy](Remove-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md index d3e89bb12a..556e9c6bbe 100644 --- a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings +applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPlatformServiceSettings schema: 2.0.0 manager: rogupta @@ -13,7 +13,7 @@ ms.reviewer: # Get-CsPlatformServiceSettings ## SYNOPSIS -Returns information about Skype for Business on Mac capabilites which have been enabled in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). +Returns information about Skype for Business on Mac capabilities which have been enabled in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). ## SYNTAX @@ -110,8 +110,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsPool.md b/skype/skype-ps/skype/Get-CsPool.md index 69840b66b2..8c56497961 100644 --- a/skype/skype-ps/skype/Get-CsPool.md +++ b/skype/skype-ps/skype/Get-CsPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspool +online version: https://learn.microsoft.com/powershell/module/skype/get-cspool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPool schema: 2.0.0 @@ -175,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsSite](Get-CsSite.md) [Get-CsTopology](Get-CsTopology.md) - diff --git a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md b/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md index 35cc7ad0da..d29e9701e9 100644 --- a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md +++ b/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspoolbackuprelationship +online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolbackuprelationship applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPoolBackupRelationship schema: 2.0.0 @@ -111,4 +111,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsPoolFabricState.md b/skype/skype-ps/skype/Get-CsPoolFabricState.md index 50fa7c9e40..2e915d6108 100644 --- a/skype/skype-ps/skype/Get-CsPoolFabricState.md +++ b/skype/skype-ps/skype/Get-CsPoolFabricState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspoolfabricstate +online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolfabricstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPoolFabricState schema: 2.0.0 @@ -324,5 +324,3 @@ String value representing the fabric state. ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md b/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md index a9a72b1d58..db2ff87bbf 100644 --- a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md +++ b/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspoolupgradereadinessstate +online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolupgradereadinessstate applicable: Lync Server 2013, Skype for Business Server 2015 title: Get-CsPoolUpgradeReadinessState schema: 2.0.0 @@ -132,4 +132,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsPresenceManagementState.md b/skype/skype-ps/skype/Get-CsPresenceManagementState.md index 2bf0fd2184..73930cdaf6 100644 --- a/skype/skype-ps/skype/Get-CsPresenceManagementState.md +++ b/skype/skype-ps/skype/Get-CsPresenceManagementState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspresencemanagementstate +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencemanagementstate applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPresenceManagementState schema: 2.0.0 @@ -95,4 +95,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsPresenceManagementState](Set-CsPresenceManagementState.md) - diff --git a/skype/skype-ps/skype/Get-CsPresencePolicy.md b/skype/skype-ps/skype/Get-CsPresencePolicy.md index f925534961..f4d0e7294a 100644 --- a/skype/skype-ps/skype/Get-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Get-CsPresencePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspresencepolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencepolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPresencePolicy schema: 2.0.0 manager: bulenteg @@ -204,4 +204,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsPresenceProvider.md b/skype/skype-ps/skype/Get-CsPresenceProvider.md index 02627be7bb..8051cd503e 100644 --- a/skype/skype-ps/skype/Get-CsPresenceProvider.md +++ b/skype/skype-ps/skype/Get-CsPresenceProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPresenceProvider schema: 2.0.0 @@ -166,4 +166,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) [Set-CsPresenceProvider](Set-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md index 5389570109..f008d70f24 100644 --- a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csprivacyconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csprivacyconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPrivacyConfiguration schema: 2.0.0 manager: bulenteg @@ -204,4 +204,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsProxyConfiguration.md b/skype/skype-ps/skype/Get-CsProxyConfiguration.md index 54335cd4b2..8ab2e40fe6 100644 --- a/skype/skype-ps/skype/Get-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/Get-CsProxyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsProxyConfiguration schema: 2.0.0 @@ -173,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsPstnUsage.md b/skype/skype-ps/skype/Get-CsPstnUsage.md index 9b62db57ac..3905df1116 100644 --- a/skype/skype-ps/skype/Get-CsPstnUsage.md +++ b/skype/skype-ps/skype/Get-CsPstnUsage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspstnusage +online version: https://learn.microsoft.com/powershell/module/skype/get-cspstnusage applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPstnUsage schema: 2.0.0 @@ -163,4 +163,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-CsVoicePolicy](Get-CsVoicePolicy.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsPublicProvider.md b/skype/skype-ps/skype/Get-CsPublicProvider.md index 4dc42352f8..e896dc4205 100644 --- a/skype/skype-ps/skype/Get-CsPublicProvider.md +++ b/skype/skype-ps/skype/Get-CsPublicProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skype/get-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPublicProvider schema: 2.0.0 @@ -178,4 +178,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md index edc0d93bef..c691ad8fc7 100644 --- a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPushNotificationConfiguration schema: 2.0.0 manager: bulenteg @@ -211,8 +211,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) -[Remove-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsQoEConfiguration.md b/skype/skype-ps/skype/Get-CsQoEConfiguration.md index ee563ff861..df091a86aa 100644 --- a/skype/skype-ps/skype/Get-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/Get-CsQoEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsQoEConfiguration schema: 2.0.0 @@ -153,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsQoEConfiguration](Remove-CsQoEConfiguration.md) [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md b/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md index ea1669f54b..e5b7e3c765 100644 --- a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRegistrarConfiguration schema: 2.0.0 @@ -177,4 +177,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsReportingConfiguration.md b/skype/skype-ps/skype/Get-CsReportingConfiguration.md index 30969717f8..6a67e67c54 100644 --- a/skype/skype-ps/skype/Get-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsReportingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsReportingConfiguration schema: 2.0.0 @@ -154,4 +154,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md b/skype/skype-ps/skype/Get-CsRgsAgentGroup.md index b245c8d476..c55cfb40ac 100644 --- a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/Get-CsRgsAgentGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRgsAgentGroup schema: 2.0.0 @@ -181,4 +181,3 @@ A string value representing the Identity of the Response Group agent group. [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsConfiguration.md b/skype/skype-ps/skype/Get-CsRgsConfiguration.md index 90a00d191b..efecbe98eb 100644 --- a/skype/skype-ps/skype/Get-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Get-CsRgsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRgsConfiguration schema: 2.0.0 @@ -114,4 +114,3 @@ A string value representing the Identity of the Response Group configuration set [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) [Set-CsRgsConfiguration](Set-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md b/skype/skype-ps/skype/Get-CsRgsHolidaySet.md index 0cbcf6b081..2b7b8d3bf5 100644 --- a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/Get-CsRgsHolidaySet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRgsHolidaySet schema: 2.0.0 @@ -197,4 +197,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md index acce5ee5ab..8f06475469 100644 --- a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRgsHoursOfBusiness schema: 2.0.0 @@ -195,4 +195,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsQueue.md b/skype/skype-ps/skype/Get-CsRgsQueue.md index d2a3ecc805..80bee92147 100644 --- a/skype/skype-ps/skype/Get-CsRgsQueue.md +++ b/skype/skype-ps/skype/Get-CsRgsQueue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRgsQueue schema: 2.0.0 @@ -182,4 +182,3 @@ A string value representing the Identity of the Response Group queue. [Remove-CsRgsQueue](Remove-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/Get-CsRgsWorkflow.md b/skype/skype-ps/skype/Get-CsRgsWorkflow.md index 4c159ce97b..2e3ca094e9 100644 --- a/skype/skype-ps/skype/Get-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/Get-CsRgsWorkflow.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRgsWorkflow schema: 2.0.0 @@ -193,4 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md b/skype/skype-ps/skype/Get-CsRoutingConfiguration.md index 70e4e8a654..a17cb208b0 100644 --- a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsRoutingConfiguration schema: 2.0.0 @@ -123,4 +123,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsRoutingConfiguration](Set-CsRoutingConfiguration.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsServerApplication.md b/skype/skype-ps/skype/Get-CsServerApplication.md index eb7915293f..79fa934203 100644 --- a/skype/skype-ps/skype/Get-CsServerApplication.md +++ b/skype/skype-ps/skype/Get-CsServerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skype/get-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsServerApplication schema: 2.0.0 @@ -193,4 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsServerApplication](Remove-CsServerApplication.md) [Set-CsServerApplication](Set-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsServerPatchVersion.md b/skype/skype-ps/skype/Get-CsServerPatchVersion.md index fb880b6921..707697cc6e 100644 --- a/skype/skype-ps/skype/Get-CsServerPatchVersion.md +++ b/skype/skype-ps/skype/Get-CsServerPatchVersion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csserverpatchversion +online version: https://learn.microsoft.com/powershell/module/skype/get-csserverpatchversion applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsServerPatchVersion schema: 2.0.0 @@ -67,4 +67,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsServerVersion.md b/skype/skype-ps/skype/Get-CsServerVersion.md index 9f40b8f89f..8335546002 100644 --- a/skype/skype-ps/skype/Get-CsServerVersion.md +++ b/skype/skype-ps/skype/Get-CsServerVersion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csserverversion +online version: https://learn.microsoft.com/powershell/module/skype/get-csserverversion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsServerVersion schema: 2.0.0 @@ -74,4 +74,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsService.md b/skype/skype-ps/skype/Get-CsService.md index 7bd1ec9aea..c0a5253689 100644 --- a/skype/skype-ps/skype/Get-CsService.md +++ b/skype/skype-ps/skype/Get-CsService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csservice +online version: https://learn.microsoft.com/powershell/module/skype/get-csservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsService schema: 2.0.0 @@ -863,4 +863,3 @@ For example: [Set-CsUserServer](Set-CsUserServer.md) [Set-CsWebServer](Set-CsWebServer.md) - diff --git a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md index a258d8bddb..aa3aa23c6e 100644 --- a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSimpleUrlConfiguration schema: 2.0.0 @@ -33,12 +33,12 @@ Get-CsSimpleUrlConfiguration [-Filter ] [-Tenant ] [-LocalStore] [ ## DESCRIPTION In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 helped overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -221,4 +221,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsSipDomain.md b/skype/skype-ps/skype/Get-CsSipDomain.md index 1287309a6b..0b57d1b663 100644 --- a/skype/skype-ps/skype/Get-CsSipDomain.md +++ b/skype/skype-ps/skype/Get-CsSipDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skype/get-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSipDomain schema: 2.0.0 @@ -136,4 +136,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsSipDomain](Remove-CsSipDomain.md) [Set-CsSipDomain](Set-CsSipDomain.md) - diff --git a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md index a0d72c6701..ffac7c3b58 100644 --- a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/get-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSipResponseCodeTranslationRule schema: 2.0.0 @@ -175,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/Get-CsSite.md b/skype/skype-ps/skype/Get-CsSite.md index 7e322d5bb7..fca553017d 100644 --- a/skype/skype-ps/skype/Get-CsSite.md +++ b/skype/skype-ps/skype/Get-CsSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cssite +online version: https://learn.microsoft.com/powershell/module/skype/get-cssite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSite schema: 2.0.0 @@ -141,4 +141,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsSite](Set-CsSite.md) - diff --git a/skype/skype-ps/skype/Get-CsSlaConfiguration.md b/skype/skype-ps/skype/Get-CsSlaConfiguration.md index 2f36309415..6e91991f77 100644 --- a/skype/skype-ps/skype/Get-CsSlaConfiguration.md +++ b/skype/skype-ps/skype/Get-CsSlaConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csslaconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSlaConfiguration schema: 2.0.0 manager: rogupta @@ -133,4 +133,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md index dd0c2eca5d..58237d6f2b 100644 --- a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsStaticRoutingConfiguration schema: 2.0.0 @@ -180,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md index 45698ae828..c6356193a8 100644 --- a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsStorageServiceConfiguration schema: 2.0.0 @@ -165,4 +165,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md index 6611e9e6a7..4c98490cbe 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration -applicable: Skype for Business Online, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTeamsUpgradeConfiguration schema: 2.0.0 manager: bulenteg @@ -124,4 +124,4 @@ These settings are only honored by newer versions of Skype for Business clients. [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md index c663914c3c..69d65757c9 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 title: Get-CsTeamsUpgradePolicy schema: 2.0.0 @@ -39,7 +39,7 @@ NOTES: - If you are using Skype for Business Server, there are no built-in instances and you'll need to create one. Also, only the NotifySfBUsers property is available. Mode is not present. - Using TeamsUpgradePolicy in an on-premises environmention requires Skype for Business Server 2015 with CU8 or later. -You can also find more guidance here: [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). +You can also find more guidance here: [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). ## EXAMPLES @@ -197,5 +197,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) - +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeStatus.md b/skype/skype-ps/skype/Get-CsTeamsUpgradeStatus.md deleted file mode 100644 index 9470e5c738..0000000000 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradeStatus.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsupgradestatus -applicable: Skype for Business Online -title: Get-CsTeamsUpgradeStatus -schema: 2.0.0 -manager: -author: salarson -ms.author: salarson -ms.reviewer: ---- - -# Get-CsTeamsUpgradeStatus - -## SYNOPSIS -Returns information related to the Microsoft-driven automated upgrade status from Skype for Business Online to Teams. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsUpgradeStatus [-Tenant ] [-WhatIf] [-Confirm] [] -``` - -### Filter -``` -Get-CsTeamsUpgradeStatus [-Tenant ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -TeamsUpgradeStatus is used to check the status of customers eligible for Microsoft-driven automated upgrade of Skype for Business Online to Teams. - -You can also find more guidance here: [Getting started with your Microsoft Teams upgrade](https://docs.microsoft.com/MicrosoftTeams/upgrade-start-here). - -## EXAMPLES - -### Example 1: The below example shows an example of TeamsUpgradeStatus with the tenant being scheduled for Microsoft-driven automated upgrade. - -> [!NOTE] -> The PowerShell results get populated at the same time upgrade notification is sent and may be null if the tenant is not yet notified. - -``` -PS C:\> Get-CsTeamsUpgradeStatus - -TenantId : ca573b31-a0db-4185-951e-3af848668397 -State : ScheduledForUpgrade -OptInEligibleDate : 2018-04-12 18:06:36Z -UpgradeScheduledDate : 2018-06-15 00:00:00Z -UserNotificationDate : 2018-07-05 00:00:00Z -UpgradeDate : 2018-07-10 00:00:00Z -LastStateChangeDate : 2018-06-06 22:52:21Z -``` - -For more information on the results from the above example please reference the table below: - -- State: Tenant is scheduled to be upgraded via automated upgrade on the date returned. -- OptInEligbleDate: Tenant is OptInEligible since 2018-04-12 18:06:36Z. (tenant admin can upgrade users on own since 2018-04-12 18:06:36Z) -- UpgradeScheduledDate: Tenant's upgrade is/was scheduled to start at 2018-06-15 00:00:00Z. (When the tenant was first notified of the upgrade via the M365 Message Center) -- UserNotificationDate: Tenant's end users will be/were notified starting 2018-07-05 00:00:00Z via SfB Client. -- UpgradeDate: Tenant will be/was upgraded by Microsoft at 2018-07-10 00:00:00Z -- LastStateChangeDate: Tenant's state was last changed at 2018-06-06 22:52:21Z. - -For more information on the various upgrade "States" please reference the table below: - -- Null - Tenant isn't yet in the automated upgrade system. -- OptInEligible - Tenant will be invited to a Microsoft driven upgrade at some point in the future. -- ScheduledForUpgrade - Tenant is scheduled to be upgraded via automated upgrade on the date returned. This refers to the date that the tenant was first scheduled. Admins who click the Postpone button in the Teams Admin Portal will see the UpgradeDate move out 30 days but will not see a change in the Upgrade ScheduledDate field nor the OptInEligibleDate field. -- Upgraded - Date that Tenant will be or has been upgraded. -- Exempt - Tenant is exempt from Microsoft driven upgrade currently. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### None - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) - -[Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) - -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) - -[Skype for Business Online retirement on July 31, 2021](https://support.microsoft.com/help/4511540/retirement-of-skype-for-business-online) - -[Upgrade Basic guidance](https://docs.microsoft.com/MicrosoftTeams/upgrade-basic) - -[Transitioning from Skype for Business to Microsoft Teams via FastTrack](https://www.microsoft.com/fasttrack/skype-for-business-transition-to-teams?rtc=1) diff --git a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md b/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md index 1a7ca78933..53ce0dee66 100644 --- a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTelemetryConfiguration schema: 2.0.0 @@ -122,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md b/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md index af171c8176..af7842ce10 100644 --- a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenanthybridconfiguration -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/get-cstenanthybridconfiguration +applicable: Skype for Business Server 2019 title: Get-CsTenantHybridConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantHybridConfiguration @@ -174,4 +174,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-CsTenantHybridConfiguration](Set-CsTenantHybridConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTenantPublicProvider.md b/skype/skype-ps/skype/Get-CsTenantPublicProvider.md deleted file mode 100644 index ad38e07162..0000000000 --- a/skype/skype-ps/skype/Get-CsTenantPublicProvider.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantpublicprovider -applicable: Skype for Business Online -title: Get-CsTenantPublicProvider -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Get-CsTenantPublicProvider - -## SYNOPSIS -Returns information indicating whether Skype for Business Online users are allowed to communicate with people who have accounts on the third-party IM and presence providers Windows Live, AOL, and Yahoo. - -## SYNTAX - -``` -Get-CsTenantPublicProvider [-Tenant ] [] -``` - -## DESCRIPTION -Public providers are organizations that provide SIP communication services for the general public. -When you establish a federation relationship with a public provider, you effectively establish federation with any user who has an account hosted by that provider. -For example, if you federate with Windows Live, then your users will be able to exchange instant messages and presence information with anyone who has a Windows Live instant messaging account. - -Skype for Business Online gives administrators the option of configuring federation with one or more of the following public IM and presence providers: - -Windows Live - -AOL - -Yahoo! - -Administrators can use the Get-CsTenantPublicProvider cmdlet to determine which of those providers (if any) have been enabled for federation. -When you call the Get-CsTenantPublicProvider cmdlet you will get back information similar to this: - -PublicProviderSet DomainPicStatus - ------------------- ------------------------ - -True {Microsoft.Rtc.Management.Hosted.DomainPICStatus} - -The PublicProviderSet property indicates whether or not federation has been enabled for one or more public provider. -If PublicProviderSet is equal to True then that means federation has been enabled with at least one provider; if PublicProviderSet is equal to False then that means that federation is disabled for all three public providers (Windows Live, AOL, and Yahoo). -To determine the actual status of each provider use this command: - -Get-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" | Select-Object -ExpandProperty DomainPICStatus - -Note that simply enabling the status of a public provider does not mean that users can exchange instant messages and presence information with users who have accounts on that provider. -In addition to enabling federation with the provider itself, administrators must also set the AllowPublicUsers property of the federation configuration settings to True. -If this property is set to False then communication will not be allowed with any of the public providers, regardless of the public provider configuration settings. - -For more information, see the help topic for the Set-CsTenantFederationConfiguration cmdlet. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Get-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" | Select-Object -ExpandProperty DomainPICStatus -``` - -Example 1 returns detailed information about the status of all the public providers assigned to the tenant bf19b7db-6960-41e5-a139-2aa373474354. -To do this, the command first uses the Get-CsTenantPublicProvider cmdlet to return public provider information for the specified tenant. -That information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the DomainPICStatus property. -Expanding a property simply means displaying all the values stored in that property onscreen, and in an easy-to-read format. - -### -------------------------- Example 2 -------------------------- -``` -Get-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" | Select-Object -ExpandProperty DomainPICStatus | Where-Object {$_.Status -eq "Enabled"} -``` - -The command shown in Example 23 is a variation of the command shown in Example 1. -In Example 2, however, the public provider information returned by "expanding" the value of the DomainPICStatus property is, in turn, piped to the Where-Object cmdlet. -The Where-Object cmdlet then picks out only those providers where the Status property is set to Enabled. -The net effect is to display only those public providers that are enabled for use. - - -## PARAMETERS - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose public provider settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Microsoft.Rtc.Management.Hosted.TenantPICStatus - - -## NOTES - - -## RELATED LINKS - -[Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) - -[Set-CsTenantPublicProvider](Set-CsTenantPublicProvider.md) - diff --git a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md index f0f3b3da5d..375176efc1 100644 --- a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skype/get-cstenantupdatetimewindow applicable: Skype for Business Online title: Get-CsTenantUpdateTimeWindow schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantUpdateTimeWindow @@ -131,4 +131,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTestDevice.md b/skype/skype-ps/skype/Get-CsTestDevice.md index 4d0d6d508d..079667d0d1 100644 --- a/skype/skype-ps/skype/Get-CsTestDevice.md +++ b/skype/skype-ps/skype/Get-CsTestDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skype/get-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTestDevice schema: 2.0.0 @@ -171,4 +171,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTestDevice](Remove-CsTestDevice.md) [Set-CsTestDevice](Set-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/Get-CsTestUserCredential.md b/skype/skype-ps/skype/Get-CsTestUserCredential.md index bb51a50675..328d03a5ff 100644 --- a/skype/skype-ps/skype/Get-CsTestUserCredential.md +++ b/skype/skype-ps/skype/Get-CsTestUserCredential.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstestusercredential +online version: https://learn.microsoft.com/powershell/module/skype/get-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTestUserCredential schema: 2.0.0 @@ -116,4 +116,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) [Set-CsTestUserCredential](Set-CsTestUserCredential.md) - diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md index c770963e28..eec5a7e4a6 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsThirdPartyVideoSystem schema: 2.0.0 @@ -252,4 +252,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md index e1f2c87c2d..372623ffd8 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsThirdPartyVideoSystemPolicy schema: 2.0.0 @@ -199,4 +199,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsTopology.md b/skype/skype-ps/skype/Get-CsTopology.md index b6398ae51d..4f487076f5 100644 --- a/skype/skype-ps/skype/Get-CsTopology.md +++ b/skype/skype-ps/skype/Get-CsTopology.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstopology +online version: https://learn.microsoft.com/powershell/module/skype/get-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTopology schema: 2.0.0 @@ -122,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Publish-CsTopology](Publish-CsTopology.md) [Test-CsTopology](Test-CsTopology.md) - diff --git a/skype/skype-ps/skype/Get-CsTrunk.md b/skype/skype-ps/skype/Get-CsTrunk.md index 7e48d07493..96dffbef9c 100644 --- a/skype/skype-ps/skype/Get-CsTrunk.md +++ b/skype/skype-ps/skype/Get-CsTrunk.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstrunk +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunk applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTrunk schema: 2.0.0 @@ -164,4 +164,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md b/skype/skype-ps/skype/Get-CsTrunkConfiguration.md index a285e08f5d..c3be85f003 100644 --- a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTrunkConfiguration schema: 2.0.0 @@ -140,4 +140,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-CsTrunkConfiguration](Set-CsTrunkConfiguration.md) [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplication.md b/skype/skype-ps/skype/Get-CsTrustedApplication.md index 693516e384..b4d37f606f 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplication.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTrustedApplication schema: 2.0.0 @@ -192,4 +192,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-CsTrustedApplication](Remove-CsTrustedApplication.md) [Set-CsTrustedApplication](Set-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md b/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md index b93776351c..17ccc65a5d 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstrustedapplicationcomputer +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTrustedApplicationComputer schema: 2.0.0 @@ -173,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) [Remove-CsTrustedApplicationComputer](Remove-CsTrustedApplicationComputer.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md index 2158976cb3..d41c6cd9e1 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTrustedApplicationEndpoint schema: 2.0.0 @@ -228,4 +228,3 @@ Accepts a pipelined string value representing the Identity of a user account. [Remove-CsTrustedApplicationEndpoint](Remove-CsTrustedApplicationEndpoint.md) [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md b/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md index d6f477e119..c790d1b493 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTrustedApplicationPool schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md index e56bd33b32..7441f11f69 100644 --- a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csucphoneconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csucphoneconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUCPhoneConfiguration schema: 2.0.0 manager: bulenteg @@ -221,4 +221,3 @@ The Get-CsUCPhoneConfiguration cmdlet returns instances of the Microsoft.Rtc.Man [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsUICulture.md b/skype/skype-ps/skype/Get-CsUICulture.md index 4467ddae82..071c8309d1 100644 --- a/skype/skype-ps/skype/Get-CsUICulture.md +++ b/skype/skype-ps/skype/Get-CsUICulture.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuiculture +online version: https://learn.microsoft.com/powershell/module/skype/get-csuiculture applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUICulture schema: 2.0.0 @@ -84,4 +84,3 @@ The Get-CsUICulture cmdlet returns instances of the System.Globalization.Culture ## RELATED LINKS [Set-CsUICulture](Set-CsUICulture.md) - diff --git a/skype/skype-ps/skype/Get-CsUnassignedNumber.md b/skype/skype-ps/skype/Get-CsUnassignedNumber.md index 7c43ed9e3a..903f8ebaea 100644 --- a/skype/skype-ps/skype/Get-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/Get-CsUnassignedNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skype/get-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUnassignedNumber schema: 2.0.0 @@ -143,4 +143,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnounce [Remove-CsUnassignedNumber](Remove-CsUnassignedNumber.md) [Set-CsUnassignedNumber](Set-CsUnassignedNumber.md) - diff --git a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md b/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md index a7eca11ea7..e8d813bd7c 100644 --- a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md +++ b/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csupgradedomaininfo +online version: https://learn.microsoft.com/powershell/module/skype/get-csupgradedomaininfo applicable: Skype for Business Server 2019 title: Get-CsUpgradeDomainInfo schema: 2.0.0 @@ -124,4 +124,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsUser.md b/skype/skype-ps/skype/Get-CsUser.md index 3ef6d380ea..c59d7c3028 100644 --- a/skype/skype-ps/skype/Get-CsUser.md +++ b/skype/skype-ps/skype/Get-CsUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuser +online version: https://learn.microsoft.com/powershell/module/skype/get-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUser schema: 2.0.0 @@ -49,7 +49,7 @@ For example, if you don't want to return all your Skype for Business Server user (These parameters are mutually exclusive: if you use Filter in a command you cannot use LdapFilter in that same command, and vice-versa.) The Filter parameter enables you to limit the returned data to users who meet the specified Skype for Business Server criteria; for example, you might decide to return only users with accounts on the specified Registrar pool, or only users who have been enabled for Enterprise Voice. The LdapFilter parameter enables you to limit the returned data to users who fit other Active Directory-based criteria; for example, users who work in a specified state or province, users who do or do not have a pager, or users with a designated job title. -**Note: the equivalent command for Skype for Business Online is [Get-CsOnlineUser](https://docs.microsoft.com/powershell/module/skype/get-csonlineuser?view=skype-ps)**. +**Note: the equivalent command for Skype for Business Online is [Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/skype/get-csonlineuser?view=skype-ps)**. ## EXAMPLES @@ -415,4 +415,3 @@ The Get-CsUser cmdlet returns instances of the Microsoft.Rtc.Management.ADConnec [Move-CsUser](Move-CsUser.md) [Set-CsUser](Set-CsUser.md) - diff --git a/skype/skype-ps/skype/Get-CsUserAcp.md b/skype/skype-ps/skype/Get-CsUserAcp.md index ca2dadaccb..430f4b037c 100644 --- a/skype/skype-ps/skype/Get-CsUserAcp.md +++ b/skype/skype-ps/skype/Get-CsUserAcp.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuseracp -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csuseracp +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserAcp schema: 2.0.0 manager: bulenteg @@ -37,7 +37,7 @@ Get-CsUserAcp [[-Identity] ] [-Credential ] [-Fil ``` ## DESCRIPTION -Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://docs.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. +Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://learn.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. An audio conferencing provider is a third-party company that provides organizations with conferencing services. Among other things, audio conferencing providers provide a way for users located off site, and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or meeting. @@ -247,4 +247,3 @@ The Get-CsUserAcp cmdlet returns instances of the Microsoft.Rtc.Management.ADCon [Remove-CsUserAcp](Remove-CsUserAcp.md) [Set-CsUserAcp](Set-CsUserAcp.md) - diff --git a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md b/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md index 0cda5d56e6..3fa9eb9579 100644 --- a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csusercallforwardingsettings +online version: https://learn.microsoft.com/powershell/module/skype/get-csusercallforwardingsettings applicable: Skype for Business Server 2019 title: Get-CsUserCallForwardingSettings schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsUserDatabaseState.md b/skype/skype-ps/skype/Get-CsUserDatabaseState.md index b0db7c2cd4..e213d9e530 100644 --- a/skype/skype-ps/skype/Get-CsUserDatabaseState.md +++ b/skype/skype-ps/skype/Get-CsUserDatabaseState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserdatabasestate +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdatabasestate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserDatabaseState schema: 2.0.0 @@ -144,6 +144,3 @@ The Get-CsUserDatabaseState cmdlet returns instances of the Microsoft.Rtc.Manage [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) [Update-CsUserDatabase](Update-CsUserDatabase.md) - - - diff --git a/skype/skype-ps/skype/Get-CsUserDelegates.md b/skype/skype-ps/skype/Get-CsUserDelegates.md index d5cec101b1..414d0cf5f2 100644 --- a/skype/skype-ps/skype/Get-CsUserDelegates.md +++ b/skype/skype-ps/skype/Get-CsUserDelegates.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserdelegates +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdelegates applicable: Skype for Business Server 2019 title: Get-CsUserDelegates schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsUserLocationStatus.md b/skype/skype-ps/skype/Get-CsUserLocationStatus.md index 0e58da1a48..88057a3b23 100644 --- a/skype/skype-ps/skype/Get-CsUserLocationStatus.md +++ b/skype/skype-ps/skype/Get-CsUserLocationStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserlocationstatus +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserlocationstatus applicable: Skype for Business Online title: Get-CsUserLocationStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserLocationStatus @@ -123,4 +123,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsUserPoolInfo.md b/skype/skype-ps/skype/Get-CsUserPoolInfo.md index 71520bfa48..dc820faa56 100644 --- a/skype/skype-ps/skype/Get-CsUserPoolInfo.md +++ b/skype/skype-ps/skype/Get-CsUserPoolInfo.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserpoolinfo +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpoolinfo applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserPoolInfo schema: 2.0.0 @@ -169,5 +169,3 @@ The Get-CsUserPoolInfo cmdlet returns instances of the Microsoft.Rtc.Management. ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsUserPstnSettings.md b/skype/skype-ps/skype/Get-CsUserPstnSettings.md index 7d95f7d9c9..0db2a2b553 100644 --- a/skype/skype-ps/skype/Get-CsUserPstnSettings.md +++ b/skype/skype-ps/skype/Get-CsUserPstnSettings.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserpstnsettings +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpstnsettings applicable: Skype for Business Online title: Get-CsUserPstnSettings schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserPstnSettings @@ -139,5 +139,3 @@ The Get-CsUserPstnSettings cmdlet returns instances of the UserPstnSettings obje ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md index 85459ee198..479833bdf5 100644 --- a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserreplicatorconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserReplicatorConfiguration schema: 2.0.0 @@ -160,4 +160,3 @@ The Get-CsUserReplicatorConfiguration cmdlet returns instances of the Microsoft. [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md b/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md index 6cc963193e..110e94585e 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserservicesconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserServicesConfiguration schema: 2.0.0 @@ -194,4 +194,3 @@ The Get-CsUserServicesConfiguration cmdlet returns instances of the Microsoft.Rt [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md b/skype/skype-ps/skype/Get-CsUserServicesPolicy.md index ee14d5fa24..2feb41556d 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Get-CsUserServicesPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserservicespolicy -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicespolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserServicesPolicy schema: 2.0.0 manager: bulenteg @@ -215,4 +215,3 @@ The Get-CsUserServicesPolicy cmdlet returns instances of the Microsoft.Rtc.Manag [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsUserSession.md b/skype/skype-ps/skype/Get-CsUserSession.md index 191d0828c0..8871e70049 100644 --- a/skype/skype-ps/skype/Get-CsUserSession.md +++ b/skype/skype-ps/skype/Get-CsUserSession.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csusersession +online version: https://learn.microsoft.com/powershell/module/skype/get-csusersession applicable: Skype for Business Online title: Get-CsUserSession schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserSession @@ -22,7 +22,7 @@ Get-CsUserSession -StartTime -User [-EndTime . +**Deprecation Notice**: We will be retiring this feature and cmdlet from Skype for Business Online beginning 5/30/2020. Instead, we recommend the utilization of MS Graph Call Records API, which is where we will continue to invest our development resources. For more information, see . Use the Get-CsUserSession cmdlet to retrieve session information for users within a specified date range within the past 30 days. @@ -105,4 +105,3 @@ The Get-CsUserSession cmdlet returns an instance of the Microsoft.Rtc.Management ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md b/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md index 33f72bd5ea..f92d47dd5f 100644 --- a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md +++ b/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csusersettingspageconfiguration -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csusersettingspageconfiguration +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserSettingsPageConfiguration schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Get-CsUserTeamMembers.md b/skype/skype-ps/skype/Get-CsUserTeamMembers.md index ab4b0a7a81..a5584e71ca 100644 --- a/skype/skype-ps/skype/Get-CsUserTeamMembers.md +++ b/skype/skype-ps/skype/Get-CsUserTeamMembers.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csuserteammembers +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserteammembers applicable: Skype for Business Server 2019 title: Get-CsUserTeamMembers schema: 2.0.0 diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md index 9c764eff6f..66425ce2e9 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvideointeropserverconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVideoInteropServerConfiguration schema: 2.0.0 @@ -175,4 +175,3 @@ The Get-CsVideoInteropServerConfiguration cmdlet returns instances of the Micros [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md index 4520e978ee..007084aa59 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvideointeropserversynthetictransactionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVideoInteropServerSyntheticTransactionConfiguration schema: 2.0.0 @@ -126,4 +126,3 @@ Returns an object array, or single instance (if used with the Identity parameter [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/Get-CsVideoTrunk.md b/skype/skype-ps/skype/Get-CsVideoTrunk.md index 97122dba6a..b6024c0dac 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunk.md +++ b/skype/skype-ps/skype/Get-CsVideoTrunk.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvideotrunk +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunk applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVideoTrunk schema: 2.0.0 @@ -144,4 +144,3 @@ The Get-CsVideoTrunk cmdlet returns instances of the Microsoft.Rtc.Management.Xd ## RELATED LINKS [Set-CsVideoGateway](Set-CsVideoGateway.md) - diff --git a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md index 5cb11382ff..fc9b683da3 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvideotrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVideoTrunkConfiguration schema: 2.0.0 @@ -35,7 +35,7 @@ The Video Interop Server is a Skype service that runs on a standalone pool and c To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -171,4 +171,3 @@ The Get-CsVideoTrunkConfiguration cmdlet returns instances of the Microsoft.Rtc. [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md b/skype/skype-ps/skype/Get-CsVoiceConfiguration.md index 6282bc47a1..862ecb0444 100644 --- a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVoiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoiceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceConfiguration schema: 2.0.0 @@ -120,4 +120,3 @@ This cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.P [Set-CsVoiceConfiguration](Set-CsVoiceConfiguration.md) [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md index 6e6ec973c6..9747b6b836 100644 --- a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoicenormalizationrule +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceNormalizationRule schema: 2.0.0 @@ -172,4 +172,3 @@ The Get-CsVoiceNormalizationRule cmdlet returns instances of the Microsoft.Rtc.M [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) [Get-CsDialPlan](Get-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Get-CsVoicePolicy.md b/skype/skype-ps/skype/Get-CsVoicePolicy.md index 9695d37e86..ee4a8eb0cb 100644 --- a/skype/skype-ps/skype/Get-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Get-CsVoicePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoicePolicy schema: 2.0.0 @@ -178,4 +178,3 @@ This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Pol [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) [Test-CsVoicePolicy](Test-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceRoute.md b/skype/skype-ps/skype/Get-CsVoiceRoute.md index e9b445cb8c..f66706f65e 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Get-CsVoiceRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceRoute schema: 2.0.0 @@ -155,4 +155,3 @@ This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Pol [Set-CsVoiceRoute](Set-CsVoiceRoute.md) [Test-CsVoiceRoute](Test-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md index 774eee78d7..05f3448032 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoiceroutingpolicy -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroutingpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg @@ -169,4 +169,3 @@ The Get-CsVoiceRoutingPolicy cmdlet returns instances of the Microsoft.Rtc.Manag [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md index 172c75dcf4..3ebb3b103b 100644 --- a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceTestConfiguration schema: 2.0.0 @@ -143,4 +143,3 @@ Returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Poli [Set-CsVoiceTestConfiguration](Set-CsVoiceTestConfiguration.md) [Test-CsVoiceTestConfiguration](Test-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md index a93f2ef755..18b12a31a4 100644 --- a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvoicemailreroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoicemailReroutingConfiguration schema: 2.0.0 @@ -152,4 +152,3 @@ Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Se [Remove-CsVoicemailReroutingConfiguration](Remove-CsVoicemailReroutingConfiguration.md) [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md index 8f6c29067f..f8c31c4d96 100644 --- a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsWatcherNodeConfiguration schema: 2.0.0 @@ -171,4 +171,3 @@ The Get-CsWatcherNodeConfiguration cmdlet returns instances of the Microsoft.Rtc [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md b/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md index eed1c672a7..0955ecea76 100644 --- a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cswebserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/get-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsWebServiceConfiguration schema: 2.0.0 @@ -190,4 +190,3 @@ The Get-CsWebServiceConfiguration cmdlet returns instances of the Microsoft.Rtc. [Remove-CsWebServiceConfiguration](Remove-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Get-CsWindowsService.md b/skype/skype-ps/skype/Get-CsWindowsService.md index d0360a438d..1141e80426 100644 --- a/skype/skype-ps/skype/Get-CsWindowsService.md +++ b/skype/skype-ps/skype/Get-CsWindowsService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cswindowsservice +online version: https://learn.microsoft.com/powershell/module/skype/get-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsWindowsService schema: 2.0.0 @@ -241,4 +241,3 @@ The Get-CsWindowsService cmdlet returns instances of the Microsoft.Rtc.Managemen [Start-CsWindowsService](Start-CsWindowsService.md) [Stop-CsWindowsService](Stop-CsWindowsService.md) - diff --git a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md index ec766e5b2c..d842572c39 100644 --- a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-csxmppallowedpartner +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta @@ -158,4 +158,3 @@ The Get-CsXmppAllowedPartner cmdlet returns instances of the Microsoft.Rtc.Manag [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md b/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md index 9c70733d8a..42d1978491 100644 --- a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csxmppgatewayconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/get-csxmppgatewayconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsXmppGatewayConfiguration schema: 2.0.0 manager: rogupta @@ -148,4 +148,3 @@ The Get-CsXmppGatewayConfiguration cmdlet returns instances of the Microsoft.Rtc ## RELATED LINKS [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) - diff --git a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md b/skype/skype-ps/skype/Grant-CsArchivingPolicy.md index e6c54872c3..195e225d06 100644 --- a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsArchivingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsArchivingPolicy schema: 2.0.0 @@ -260,5 +260,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md b/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md deleted file mode 100644 index 1762e70cce..0000000000 --- a/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csbroadcastmeetingpolicy -applicable: Microsoft Teams, Skype for Business Online -title: Grant-CsBroadcastMeetingPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Grant-CsBroadcastMeetingPolicy - -## SYNOPSIS -Use the Grant-CsBroadcastMeetingPolicy cmdlet to assign a broadcast meeting policy to a user. - -## SYNTAX -``` -Grant-CsBroadcastMeetingPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Administrators can manage Broadcast meeting functionality in Microsoft Teams or Skype for Business Online using the following: - -- Broadcast meeting configuration at the tenant level -- Broadcast meeting policy at the user level -- Conferencing policy at the user level. - -Broadcast meeting configuration and broadcast meeting policy govern broadcast-specific functionality. In addition, the settings of the conferencing policy assigned to the user producing the broadcast also general conferencing settings that are also relevant for broadcast meetings. - -This document describes how to specify which broadcast meeting policy is assigned to a user. Be sure to also review the following docs to manage conferencing policy:[Grant-CsConferencingPolicy](Grant-CsConferencingPolicy.md), [New-CsConferencingPolicy](New-CsConferencingPolicy.md), and [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md). - -**NOTES**: - -- Broadcast meeting policies are predefined in Microsoft Teams or Skype for Business. The defined settings for each policy can be displayed by using the Get-CsBroadcastMeetingPolicy cmdlet with no parameters. -- New broadcast meeting policy instance can't be created, and existing policies can't be modified. They can only be granted, or assigned to users. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Grant-CsBroadcastMeetingPolicy -Identity jphillips@contoso.com -PolicyName BroadcastMeetingPolicyAllEnabled -``` - -This example grants the BroadcastMeetingPolicyAllEnabled policy to a user identified by their User Principal Name (UPN). - -### -------------------------- Example 2 -------------------------- -``` -Grant-CsBroadcastMeetingPolicy -Identity jphillips@contoso.com -PolicyName $Null -``` - -In Example 2, any per-user broadcast meeting policy previously assigned to the user jphillips is unassigned from that user; as a result, they will be managed by the global broadcast meeting policy. -To unassign a per-user policy, set the PolicyName to a null value ($Null). - - -## PARAMETERS - -### -Identity -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy to be assigned to a user. -A list of the policies for your organization can be retrieved using Get-CsBroadcastMeetingPolicy. -The PolicyName is the policy identity minus the policy scope (the "tag:" prefix). -For example, a policy with the identity "Tag:BroadcastMeetingPolicyDisabled" has a PolicyName equal to "BroadcastMeetingPolicyDisabled". -To unassign a previously assigned policy, set PolicyName to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Skype for Business 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: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Skype for Business 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 - -### -None - -## NOTES - -## RELATED LINKS - -[Get-CsBroadcastMeetingPolicy](Get-CsBroadcastMeetingPolicy.md) -[Grant-CsConferencingPolicy](Grant-CsConferencingPolicy.md) -[New-CsConferencingPolicy](New-CsConferencingPolicy.md) -[Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) -[Set-CsBroadcastMeetingConfiguration](Set-CsBroadcastMeetingConfiguration.md) - diff --git a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md index f10ae4336a..5b5a65c2cf 100644 --- a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsCallViaWorkPolicy schema: 2.0.0 @@ -179,5 +179,3 @@ None. [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsClientPolicy.md b/skype/skype-ps/skype/Grant-CsClientPolicy.md index 710cc98e64..5b614c56ca 100644 --- a/skype/skype-ps/skype/Grant-CsClientPolicy.md +++ b/skype/skype-ps/skype/Grant-CsClientPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csclientpolicy -applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsClientPolicy schema: 2.0.0 manager: bulenteg @@ -222,7 +222,6 @@ The Tenant parameter is primarily for use in a hybrid deployment. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named @@ -258,4 +257,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsClientPolicy](Remove-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md b/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md index dcfd7ae57d..f3c7b5346a 100644 --- a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsClientVersionPolicy schema: 2.0.0 @@ -248,4 +248,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md b/skype/skype-ps/skype/Grant-CsConferencingPolicy.md index cff714a80d..079b1f8b84 100644 --- a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsConferencingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csconferencingpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsConferencingPolicy schema: 2.0.0 manager: bulenteg @@ -253,5 +253,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsDialPlan.md b/skype/skype-ps/skype/Grant-CsDialPlan.md index 6c64081bd8..17aa244dd3 100644 --- a/skype/skype-ps/skype/Grant-CsDialPlan.md +++ b/skype/skype-ps/skype/Grant-CsDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csdialplan +online version: https://learn.microsoft.com/powershell/module/skype/grant-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsDialPlan schema: 2.0.0 @@ -210,4 +210,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Test-CsDialPlan](Test-CsDialPlan.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md index a0713654bf..cee8b30442 100644 --- a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csexternalaccesspolicy -applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csexternalaccesspolicy +applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsExternalAccessPolicy schema: 2.0.0 manager: bulenteg @@ -21,9 +21,24 @@ This cmdlet was introduced in Lync Server 2010. ## SYNTAX +### Identity (Default) ``` -Grant-CsExternalAccessPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsExternalAccessPolicy [] +``` + +### GrantToUser +``` +Grant-CsExternalAccessPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Group] [-Rank] [] +``` + +### GrantToTenant +``` +Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Global] [-Force] [] ``` @@ -36,19 +51,15 @@ That might be sufficient to meet your communication needs. If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation will not automatically provide users with this capability. Instead, you must enable federation, and then assign users an external access policy that gives them the right to communicate with federated users. -2. -(Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). -3. -Communicate with people who have SIP accounts with a public instant messaging service such as Skype. +3. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -4. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +4. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. When you install Skype for Business Server, a global external access policy is automatically created for you. @@ -64,7 +75,6 @@ For example, suppose you create a per-user policy that allows communication with As long as that policy is in force, Ken will be allowed to communicate with federated users even if this type of communication is not allowed by Ken's site policy or by the global policy. That's because the settings in the per-user policy take precedence. - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -74,7 +84,6 @@ Grant-CsExternalAccessPolicy -Identity "Ken Myer" -PolicyName RedmondAccessPolic Example 1 assigns the external access policy RedmondAccessPolicy to the user with the Active Directory display name Ken Myer. - ### -------------------------- EXAMPLE 2 -------------------------- ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy @@ -84,7 +93,6 @@ The command shown in Example 2 assigns the external access policy RedmondAccessP To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who work in Redmond; the filter value "l=Redmond" limits returned data to those users who work in the city of Redmond (the l in the filter, a lowercase L, represents the locality). That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection. - ### -------------------------- EXAMPLE 3 -------------------------- ``` Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy @@ -94,7 +102,6 @@ In Example 3, all the users who have the job title "Sales Representative" are as To perform this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the Sales Representatives; the filter value "Title=Sales Representative" restricts the returned collection to users who have the job title "Sales Representative". This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection. - ### -------------------------- EXAMPLE 4 -------------------------- ``` Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy @@ -104,7 +111,6 @@ The command shown in Example 4 assigns the external access policy BasicAccessPol (That is, users currently being governed by a site policy or by the global policy.) To do this, the Get-CsUser cmdlet and the Filter parameter are used to return the appropriate set of users; the filter value {ExternalAccessPolicy -eq $Null} limits the returned data to user accounts where the ExternalAccessPolicy property is equal to (-eq) a null value ($Null). By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy. - ### -------------------------- EXAMPLE 5 -------------------------- ``` Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy @@ -114,7 +120,6 @@ Example 5 assigns the external access policy USAccessPolicy to all the users who The command starts off by calling the Get-CsUser cmdlet and the OU parameter; the parameter value "ou=US,dc=litwareinc,dc=com" limits the returned data to user accounts found in the US OU. The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection. - ### -------------------------- EXAMPLE 6 -------------------------- ``` Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null @@ -124,7 +129,6 @@ Example 6 unassigns any per-user external access policy previously assigned to a To do this, the command calls the Get-CsUser cmdlet (without any additional parameters) in order to return a collection of all the users enabled for Skype for Business Server. That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which uses the syntax "`-PolicyName $Null`" to remove any per-user external access policy previously assigned to these users. - ## PARAMETERS ### -Identity @@ -137,7 +141,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```yaml Type: UserIdParameter -Parameter Sets: (All) +Parameter Sets: GrantToUser Aliases: Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 @@ -250,6 +254,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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).` @@ -290,5 +339,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsGraphPolicy.md b/skype/skype-ps/skype/Grant-CsGraphPolicy.md index af4358e6ed..d1c384d7e3 100644 --- a/skype/skype-ps/skype/Grant-CsGraphPolicy.md +++ b/skype/skype-ps/skype/Grant-CsGraphPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csgraphpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy +applicable: Lync Server 2010 title: Grant-CsGraphPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsGraphPolicy @@ -65,7 +65,7 @@ For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled"`. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 2 @@ -81,7 +81,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -98,7 +98,7 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -114,7 +114,7 @@ Specifies the identity of the user who will be granted the graph policy. Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 1 @@ -130,7 +130,7 @@ Enables you to pass a user object through the pipeline that represents the user Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -146,7 +146,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -163,7 +163,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -188,5 +188,3 @@ The Grant-CsGraphPolicy cmdlet returns an object of type Microsoft.Rtc.Managemen ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md index 9e5f9a311e..9fe8d50ae6 100644 --- a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsHostedVoicemailPolicy schema: 2.0.0 @@ -198,4 +198,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md b/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md index ec53671eaf..0bc1ea6d26 100644 --- a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md +++ b/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csipphonepolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy +applicable: Skype for Business Server 2019 title: Grant-CsIPPhonePolicy, Skype for Business Server 2019 schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsIPPhonePolicy @@ -68,7 +68,7 @@ For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: 2 @@ -84,7 +84,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -100,7 +100,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -123,7 +123,7 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: 1 @@ -140,7 +140,7 @@ By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the p Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -156,7 +156,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -173,7 +173,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online, Skype for Business Server 2019 +applicable: Microsoft Teams, Skype for Business Server 2019 Required: False Position: Named @@ -203,5 +203,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Get-CsIPPhonePolicy](Get-CsIPPhonePolicy.md) [Set-CsIPPhonePolicy](Set-CsIPPhonePolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsLocationPolicy.md b/skype/skype-ps/skype/Grant-CsLocationPolicy.md index 718bab854e..6ea4f48cc5 100644 --- a/skype/skype-ps/skype/Grant-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Grant-CsLocationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsLocationPolicy schema: 2.0.0 @@ -216,4 +216,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Test-CsLocationPolicy](Test-CsLocationPolicy.md) [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md b/skype/skype-ps/skype/Grant-CsMobilityPolicy.md index fda2ae6ebf..a6b4002ac5 100644 --- a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Grant-CsMobilityPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csmobilitypolicy -applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsMobilityPolicy schema: 2.0.0 manager: bulenteg @@ -226,7 +226,6 @@ Accept wildcard characters: False Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named @@ -265,5 +264,3 @@ However, if you include the PassThru parameter, the cmdlet will be able to pipel ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsOUPermission.md b/skype/skype-ps/skype/Grant-CsOUPermission.md index 8d1491e4a0..222046671f 100644 --- a/skype/skype-ps/skype/Grant-CsOUPermission.md +++ b/skype/skype-ps/skype/Grant-CsOUPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csoupermission +online version: https://learn.microsoft.com/powershell/module/skype/grant-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsOUPermission schema: 2.0.0 @@ -286,5 +286,3 @@ The Grant-CsOUPermission cmdlet does not return any objects or values. [Revoke-CsOUPermission](Revoke-CsOUPermission.md) [Test-CsOUPermission](Test-CsOUPermission.md) - - diff --git a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md index cd502ce48f..2802ff6d76 100644 --- a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/grant-cspersistentchatpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta @@ -227,4 +227,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsPinPolicy.md b/skype/skype-ps/skype/Grant-CsPinPolicy.md index e949da7632..7abc34da1c 100644 --- a/skype/skype-ps/skype/Grant-CsPinPolicy.md +++ b/skype/skype-ps/skype/Grant-CsPinPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsPinPolicy schema: 2.0.0 @@ -223,5 +223,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsPinPolicy](Remove-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - - diff --git a/skype/skype-ps/skype/Grant-CsPresencePolicy.md b/skype/skype-ps/skype/Grant-CsPresencePolicy.md index 0860011f1f..0b4f666350 100644 --- a/skype/skype-ps/skype/Grant-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Grant-CsPresencePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsPresencePolicy schema: 2.0.0 @@ -240,4 +240,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsSetupPermission.md b/skype/skype-ps/skype/Grant-CsSetupPermission.md index 07982ebbf4..7884f28095 100644 --- a/skype/skype-ps/skype/Grant-CsSetupPermission.md +++ b/skype/skype-ps/skype/Grant-CsSetupPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cssetuppermission +online version: https://learn.microsoft.com/powershell/module/skype/grant-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsSetupPermission schema: 2.0.0 @@ -236,5 +236,3 @@ The Grant-CsSetupPermission cmdlet does not return any objects or values. [Revoke-CsSetupPermission](Revoke-CsSetupPermission.md) [Test-CsSetupPermission](Test-CsSetupPermission.md) - - diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index 3b9ca73d46..49be661490 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy -applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +applicable: Skype for Business Server 2019, Skype for Business Server 2015 title: Grant-CsTeamsUpgradePolicy schema: 2.0.0 manager: bulenteg @@ -18,8 +18,23 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for ## SYNTAX -```powershell -Grant-CsTeamsUpgradePolicy [-Identity] ] [-PolicyName] [-Tenant ] [-Global] [-MigrateMeetingsToTeams] [-Confirm] [] +### Identity (Default) +``` +Grant-CsTeamsUpgradePolicy [[-Identity] ] [-MigrateMeetingsToTeams ] [-PassThru] + [[-PolicyName] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Force] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -28,7 +43,9 @@ TeamsUpgradePolicy allows administrators to manage the transition from Skype for This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. -Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are listed below. +**[NOTE]** Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](/powershell/module/skype/start-csexmeetingmigration). + +Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: |Identity|Mode|NotifySfbUsers|Comments| |---|---|---|---| @@ -45,7 +62,7 @@ Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, r >[!IMPORTANT] ->TeamsUpgradePolicy can be assigned to any Teams user, whether that user have an on-premises account in Skype for Business Server or not. However, **TeamsOnly mode can only be assigned to a user who is already homed in Skype for Business Online**. This is because interop with Skype for Business users and federation as well as Microsoft 365 Phone System functionality are only possible if the user is homed in Skype for Business Online. In addition, you cannot assign TeamsOnly mode as the tenant-wide default if you have any Skype for Business on-premises deployment (which is detected by presence of a lyncdiscover DNS record that points to a location other than Office 365. To make these users TeamsOnly you must first move these users individually to the cloud using `Move-CsUser`. Once all users have been moved to the cloud, you can [disable hybrid to complete migration to the cloud](https://docs.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid) and then apply TeamsOnly mode at the tenant level to ensure future users are TeamsOnly by default. +>TeamsUpgradePolicy can be assigned to any Teams user, whether that user have an on-premises account in Skype for Business Server or not. However, **TeamsOnly mode can only be assigned to a user who is already homed in Skype for Business Online**. This is because interop with Skype for Business users and federation as well as Microsoft 365 Phone System functionality are only possible if the user is homed in Skype for Business Online. In addition, you cannot assign TeamsOnly mode as the tenant-wide default if you have any Skype for Business on-premises deployment (which is detected by presence of a lyncdiscover DNS record that points to a location other than Office 365. To make these users TeamsOnly you must first move these users individually to the cloud using `Move-CsUser`. Once all users have been moved to the cloud, you can [disable hybrid to complete migration to the cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid) and then apply TeamsOnly mode at the tenant level to ensure future users are TeamsOnly by default. > [!NOTE] @@ -63,10 +80,10 @@ Office 365 provides all relevant instances of TeamsUpgradePolicy via built-in, r > > - In Office 365, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet available. In contrast, Skype for Business Server does not contain built-in instances, so the New cmdlet is available on-premises. Only NotifySfBUsers property is available in on-premises. > -> - When granting a user a policy with mode=TeamsOnly or mode=SfBWithTeamsCollabAndMeetings, by default, meetings organized by that user will be migrated to Teams. For details, see [Using the Meeting Migration Service (MMS)](https://docs.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). +> - When granting a user a policy with mode=TeamsOnly or mode=SfBWithTeamsCollabAndMeetings, by default, meetings organized by that user will be migrated to Teams. For details, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). -When users are in any of the Skype for Business modes (SfBOnly, SfBWithTeamsCollab, SfBWithTeamsCollabAndMeetings), calling and chat functionality in the Teams app are disabled (but chat in the context of a Teams meeting is still allowed). Similarly, when users are in the SfBOnly or SfBWithTeamsCollab modes, meeting scheduling is disabled. For more details, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). +When users are in any of the Skype for Business modes (SfBOnly, SfBWithTeamsCollab, SfBWithTeamsCollabAndMeetings), calling and chat functionality in the Teams app are disabled (but chat in the context of a Teams meeting is still allowed). Similarly, when users are in the SfBOnly or SfBWithTeamsCollab modes, meeting scheduling is disabled. For more details, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). The `Grant-CsTeamsUpgradePolicy` cmdlet checks the configuration of the corresponding settings in TeamsMessagingPolicy, TeamsCallingPolicy, and TeamsMeetingPolicy to determine if those settings would be superceded by TeamsUpgradePolicy and if so, an informational message is provided in PowerShell. It is not necessary to set these other policy settings. This is for informational purposes only. Below is an example of what the PowerShell warning looks like: @@ -101,7 +118,7 @@ The above cmdlet removes any policy changes made to user Mike@contoso.com and ef PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly -Global ``` -To grant a policy to all users in the org (except any that have an explicit policy assigned), omit the identity parameter. If you do not specify the -Global paramter, you will be prompted to confirm the operation. +To grant a policy to all users in the org (except any that have an explicit policy assigned), omit the identity parameter. If you do not specify the -Global parameter, you will be prompted to confirm the operation. ### Example 4 Get a report on existing TeamsUpgradePolicy users (Screen Report) @@ -154,7 +171,7 @@ The user you want to grant policy to. This can be specified as SIP address, User ```yaml Type: UserIdParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 @@ -199,17 +216,79 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +Do not use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Specifies whether to move existing Skype for Business meetings organized by the user to Teams. This parameter can only be true if the mode of the specified policy instance is either TeamsOnly or SfBWithTeamsCollabAndMeetings, and if the policy instance is being granted to a specific user. It is not possible to trigger meeting migration when granting TeamsUpgradePolicy to the entire tenant. For more details, see [Using the meeting migration service](https://docs.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -218,15 +297,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. -Prompts you for confirmation before running the cmdlet. +By default, the cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -235,15 +314,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. -Do not use. +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -252,6 +345,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` + ## INPUTS ### Microsoft.Rtc.Management.AD.UserIdParameter @@ -263,11 +357,11 @@ Accept wildcard characters: False ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) -[Using the Meeting Migration Service (MMS)](https://docs.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) -[Coexistence with Skype for Business](https://docs.microsoft.com/microsoftteams/coexistence-chat-calls-presence) +[Coexistence with Skype for Business](https://learn.microsoft.com/microsoftteams/coexistence-chat-calls-presence) [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) diff --git a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md index 8cef5a871f..c5066205d9 100644 --- a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsThirdPartyVideoSystemPolicy schema: 2.0.0 @@ -205,4 +205,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md b/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md index d132f0b07a..cbb4c917da 100644 --- a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsUserServicesPolicy schema: 2.0.0 @@ -216,4 +216,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Grant-CsVoicePolicy.md b/skype/skype-ps/skype/Grant-CsVoicePolicy.md index 34a1151803..f553602f84 100644 --- a/skype/skype-ps/skype/Grant-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Grant-CsVoicePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsVoicePolicy schema: 2.0.0 @@ -229,6 +229,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M [Test-CsVoicePolicy](Test-CsVoicePolicy.md) [Get-CsUser](Get-CsUser.md) - -[Get-CsOnlineUser](Get-CsOnlineUser.md) - diff --git a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md index 8288f632b7..741af07a2c 100644 --- a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csvoiceroutingpolicy -applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoiceroutingpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg @@ -185,7 +185,6 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named @@ -221,4 +220,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Import-CSAnnouncementFile.md b/skype/skype-ps/skype/Import-CSAnnouncementFile.md index 9c14f30049..37882297f1 100644 --- a/skype/skype-ps/skype/Import-CSAnnouncementFile.md +++ b/skype/skype-ps/skype/Import-CSAnnouncementFile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csannouncementfile +online version: https://learn.microsoft.com/powershell/module/skype/import-csannouncementfile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CSAnnouncementFile schema: 2.0.0 @@ -17,8 +17,6 @@ ms.reviewer: Imports an announcement file to the Announcement service audio library. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ``` @@ -37,24 +35,18 @@ At that point the New-CsUnassignedNumber or Set-CsUnassignedNumber cmdlet can be Imported files must be WAV or WMA files. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- ``` -$a = Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte +$a = [System.IO.File]::ReadAllBytes('.\GreetingFile.wav') Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content $a ``` These commands import an audio file into the Announcement service File Store. -Because audio files must be imported as byte arrays, we first need to call the Get-Content cmdlet to retrieve the audio file as an array of individual bytes. -Get-Content is a Windows PowerShell built-in cmdlet to which we pass the name (including path) of the file we want to use for our announcement. -Next we pass a value of 0 to the ReadCount parameter, meaning we want to read the whole file at once. -We then pass a value of Byte to the Encoding parameter, which tells Get-Content that we want the contents of the file as an array of bytes. -We assign that array to the variable $a. +Because audio files must be imported as byte arrays, we first need to retrieve the audio file as an array of individual bytes. We assign that array to the variable $a. In the second line we call the Import-CsAnnouncementFile cmdlet to actually import the file. We pass the service Identity ApplicationServer:redmond.litwareinc.com to the Parent parameter, then we pass a name to the FileName parameter (WelcomeMessage.wav). @@ -64,23 +56,21 @@ Finally, we pass the variable $a as the value to the Content parameter to read i ### -------------------------- EXAMPLE 2 -------------------------- ``` -Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content (Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte) +Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content ([System.IO.File]::ReadAllBytes('.\GreetingFile.wav')) ``` -Example 2 is identical to Example 1 except that we included the Get-Content command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable. - +Example 2 is identical to Example 1 except that we included the command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable. ### -------------------------- EXAMPLE 3 -------------------------- ``` -Get-Content ".\GreetingFile.wav" -ReadCount 0 -Encoding Byte | Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" +[System.IO.File]::ReadAllBytes('.\GreetingFile.wav') | Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" ``` Example 3 is yet another variation of Example 1. -The difference in this example is that rather than use the Content parameter, we first call the Get-Content cmdlet, then pipe the results to Import-CsAnnouncementFile. +The difference in this example is that rather than use the Content parameter, we first call the command to read the file, then pipe the results to Import-CsAnnouncementFile. This is the most reliable way of importing an announcement file from a remote session. - ## PARAMETERS ### -Parent @@ -119,6 +109,8 @@ Accept wildcard characters: False ### -Content The contents of the audio file as a byte array. +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) @@ -199,4 +191,3 @@ This cmdlet does not return a value. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Import-CsCertificate.md b/skype/skype-ps/skype/Import-CsCertificate.md index 0555912132..ba39973617 100644 --- a/skype/skype-ps/skype/Import-CsCertificate.md +++ b/skype/skype-ps/skype/Import-CsCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-cscertificate +online version: https://learn.microsoft.com/powershell/module/skype/import-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsCertificate schema: 2.0.0 @@ -324,4 +324,3 @@ None. [Request-CsCertificate](Request-CsCertificate.md) [Set-CsCertificate](Set-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md b/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md index 950cf898f3..68beb13982 100644 --- a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md +++ b/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-cscompanyphonenormalizationrules +online version: https://learn.microsoft.com/powershell/module/skype/import-cscompanyphonenormalizationrules applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsCompanyPhoneNormalizationRules schema: 2.0.0 @@ -190,5 +190,3 @@ None [New-CsAddressBookNormalizationConfiguration](New-CsAddressBookNormalizationConfiguration.md) [Get-CsAddressBookNormalizationConfiguration](Get-CsAddressBookNormalizationConfiguration.md) - - diff --git a/skype/skype-ps/skype/Import-CsConfiguration.md b/skype/skype-ps/skype/Import-CsConfiguration.md index cc6f0a17c4..6f8f568b9c 100644 --- a/skype/skype-ps/skype/Import-CsConfiguration.md +++ b/skype/skype-ps/skype/Import-CsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/import-csconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsConfiguration schema: 2.0.0 @@ -185,5 +185,3 @@ The Import-CsConfiguration cmdlet does not return any values or objects. ## RELATED LINKS [Export-CsConfiguration](Export-CsConfiguration.md) - - diff --git a/skype/skype-ps/skype/Import-CsDeviceUpdate.md b/skype/skype-ps/skype/Import-CsDeviceUpdate.md index d0e459f353..a5c01e0bfd 100644 --- a/skype/skype-ps/skype/Import-CsDeviceUpdate.md +++ b/skype/skype-ps/skype/Import-CsDeviceUpdate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csdeviceupdate +online version: https://learn.microsoft.com/powershell/module/skype/import-csdeviceupdate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsDeviceUpdate schema: 2.0.0 @@ -189,5 +189,3 @@ The Import-CsDeviceUpdate cmdlet imports instances of the Microsoft.Rtc.Manageme ## RELATED LINKS [Get-CsDeviceUpdateRule](Get-CsDeviceUpdateRule.md) - - diff --git a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md b/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md index 72e2c374c1..aa6269159b 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md +++ b/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-cslegacyconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsLegacyConferenceDirectory schema: 2.0.0 @@ -143,5 +143,3 @@ The Import-CsLegacyConferenceDirectory cmdlet does not return any objects or val [Merge-CsLegacyTopology](Merge-CsLegacyTopology.md) [Move-CsLegacyUser](Move-CsLegacyUser.md) - - diff --git a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md b/skype/skype-ps/skype/Import-CsLegacyConfiguration.md index 7719c9bb6c..51ac1f67d2 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md +++ b/skype/skype-ps/skype/Import-CsLegacyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-cslegacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsLegacyConfiguration schema: 2.0.0 @@ -187,5 +187,3 @@ The Import-CsLegacyConfiguration cmdlet does not return any objects or values. [Merge-CsLegacyTopology](Merge-CsLegacyTopology.md) [Move-CsLegacyUser](Move-CsLegacyUser.md) - - diff --git a/skype/skype-ps/skype/Import-CsLisConfiguration.md b/skype/skype-ps/skype/Import-CsLisConfiguration.md index 0d44c5af60..20298f3573 100644 --- a/skype/skype-ps/skype/Import-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Import-CsLisConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/import-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsLisConfiguration schema: 2.0.0 @@ -17,8 +17,6 @@ ms.reviewer: Imports an Enterprise Voice Enhanced 9-1-1 (E9-1-1) configuration from a backup file. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ### ByteInput @@ -48,11 +46,8 @@ You call the Export-CsLisConfiguration cmdlet to back up your configuration. Later, you modify the Location property of that wireless access point to Building30/Rooms20-40. If you then call the Import-CsLisConfiguration cmdlet to restore the backed-up configuration, the location for that WAP will be Building30/Room10 (the location before the backup), but the location for Building30/Rooms20-40 will remain in the location configuration database. - - ## EXAMPLES - ### -------------------------- EXAMPLE 1 -------------------------- ``` @@ -61,7 +56,6 @@ Import-CsLisConfiguration -FileName C:\E911Config.bak This example imports the E9-1-1 configuration from the backup file named E911Config.back to the location configuration database. - ### -------------------------- EXAMPLE 2 -------------------------- ``` @@ -78,34 +72,25 @@ In line 2 the Import-CsLisConfiguration cmdlet is called. The ByteInput parameter receives a value of $lisconfig, which is the variable containing the byte array we exported. This will import that byte array back into the location configuration database. - - ### -------------------------- EXAMPLE 3 -------------------------- ``` $lisconfig = Export-CsLisConfiguration -AsBytes -$listconfig | Set-Content -Path C:\E911Config.bak -Encoding byte +[System.IO.File]::WriteAllBytes('C:\E911Config.bak', $lisconfig) -Get-Content -ReadCount 0 -Encoding byte -Path C:\E911Config.bak | Import-CsLisConfiguration +[System.IO.File]::ReadAllBytes('C:\E911Config.bak') | Import-CsLisConfiguration ``` Example 3 is a more complete version of Example 2. The first line is the same, we call the Export-CsLisConfiguration cmdlet with the AsBytes parameter to store the LIS configuration as an array of bytes in the variable $lisconfig. The rest of this example shows how to save that configuration to a file and then import it back into the location configuration database. -In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the Windows PowerShell Set-Content cmdlet. -We assign values to two parameters of the Set-Content cmdlet: Path and Encoding. -We assign the full path and file name of the file to which we want to save the configuration to the Path parameter. -We use the Encoding parameter with a value of byte to ensure the configuration is stored as an array of bytes. +In line 2 we pipe the contents of $lisconfig, which is the byte array representing the LIS configuration, to the full path and file name of the file to which we want to save the configuration. Finally, in line 3 we import the configuration back into the location configuration database. -First we call the Get-Content cmdlet to retrieve the contents from the file. -We pass a value of 0 to the ReadCount property, which tells the Get-Content cmdlet to read all the contents of the file at once rather than one line at a time. -We again use the Encoding parameter with a value of byte to specify what type of data we're reading from the file. -Finally we pass the file name to the Path parameter. -The contents of the file that we read with the Get-Content cmdlet is piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location configuration database. - +First we retrieve the contents from the file. +The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, which imports the saved configuration into the location database. ## PARAMETERS @@ -172,4 +157,3 @@ This cmdlet does not return a value. [Debug-CsLisConfiguration](Debug-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index b002835186..0000000000 --- a/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csorganizationalautoattendantholidays -applicable: Skype for Business Online -title: Import-CsOrganizationalAutoAttendantHolidays -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Import-CsOrganizationalAutoAttendantHolidays - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Import-CsPersistentChatData.md b/skype/skype-ps/skype/Import-CsPersistentChatData.md index 01437cb309..a6407326d2 100644 --- a/skype/skype-ps/skype/Import-CsPersistentChatData.md +++ b/skype/skype-ps/skype/Import-CsPersistentChatData.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-cspersistentchatdata -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/import-cspersistentchatdata +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsPersistentChatData schema: 2.0.0 manager: rogupta @@ -189,5 +189,3 @@ None. ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Import-CsRgsAudioFile.md b/skype/skype-ps/skype/Import-CsRgsAudioFile.md index 1eed5d8f54..2e14bd423a 100644 --- a/skype/skype-ps/skype/Import-CsRgsAudioFile.md +++ b/skype/skype-ps/skype/Import-CsRgsAudioFile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csrgsaudiofile +online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsaudiofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsRgsAudioFile schema: 2.0.0 @@ -17,8 +17,6 @@ ms.reviewer: Imports a new audio file for use with the Response Group application. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ``` @@ -37,14 +35,12 @@ Note that you must run Import-CsRgsAudioFile each time you want to use an audio For example, suppose Workflow A uses a given audio file as its custom music on hold file and you now want to use that same audio file as the custom music on hold for Workflow B. Even though the audio file is already used by the Response Group application you will still need to import the file in order to use it with Workflow B. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- ``` -$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content (Get-Content C:\Media\WhileYouWait.wav -Encoding byte -ReadCount 0) +$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) $y = Get-CsRgsWorkflow -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Workflow" @@ -58,16 +54,14 @@ To perform this task, the first command uses Import-CsRgsAudioFile to import the In addition to the Identity parameter (which specifies the service location) the FileName parameter is used to specify the file name of the file being imported. At the same time, the Content parameter is used to import the audio file. -File importing is carried out by calling the Get-Content cmdlet followed by the path to the file being imported. -Get-Content also requires you to set the encoding type to byte and the ReadCount to 0. -(Setting the ReadCount to 0 ensures that the entire file is read in a single operation.) The imported file is then stored in a variable named $x. +File importing is carried out by calling the `[System.IO.File]::ReadAllBytes` command with the path to the file being imported. +The imported file is then stored in a variable named $x. In the second command, Get-CsRgsWorkflow is used to create an object reference ($y) to the workflow Help Desk Workflow. After this object reference has been created, command 3 sets the value of the CustomMusicOnHoldFile property to $x, the variable containing the imported audio file. Finally, the last command in the example uses Set-CsRgsWorkflow to write these changes to the actual workflow Help Desk Workflow. If you do not call Set-CsRgsWorkflow, your modifications will exist only in memory, and will disappear as soon as you close Windows PowerShell or delete the variables $x or $y. - ## PARAMETERS ### -Identity @@ -89,8 +83,8 @@ Accept wildcard characters: False ### -Content Actual content of the audio file being imported. -The Content property is populated by calling the Get-Content cmdlet. -When calling Get-Content, set the Encoding parameter to byte and the ReadCount parameter to 0 (for details, see the Examples section in this topic). + +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[] @@ -191,5 +185,3 @@ Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Audio [New-CsRgsWorkflow](New-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - - diff --git a/skype/skype-ps/skype/Import-CsRgsConfiguration.md b/skype/skype-ps/skype/Import-CsRgsConfiguration.md index 505c269d29..a18372286a 100644 --- a/skype/skype-ps/skype/Import-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Import-CsRgsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsRgsConfiguration schema: 2.0.0 @@ -181,4 +181,3 @@ None. ## RELATED LINKS [Export-CsRgsConfiguration](Export-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Import-CsUserData.md b/skype/skype-ps/skype/Import-CsUserData.md index e88742f8d8..d282e09e95 100644 --- a/skype/skype-ps/skype/Import-CsUserData.md +++ b/skype/skype-ps/skype/Import-CsUserData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csuserdata +online version: https://learn.microsoft.com/powershell/module/skype/import-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsUserData schema: 2.0.0 @@ -260,5 +260,3 @@ None. [Sync-CsUserData](Sync-CsUserData.md) [Update-CsUserData](Update-CsUserData.md) - - diff --git a/skype/skype-ps/skype/Install-CsAdServerSchema.md b/skype/skype-ps/skype/Install-CsAdServerSchema.md index d31f156e3b..9a20d7aaef 100644 --- a/skype/skype-ps/skype/Install-CsAdServerSchema.md +++ b/skype/skype-ps/skype/Install-CsAdServerSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/install-csadserverschema +online version: https://learn.microsoft.com/powershell/module/skype/install-csadserverschema applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Install-CsAdServerSchema schema: 2.0.0 @@ -226,5 +226,3 @@ The Install-CsAdServerSchema cmdlet does not return any values or objects. ## RELATED LINKS [Get-CsAdServerSchema](Get-CsAdServerSchema.md) - - diff --git a/skype/skype-ps/skype/Install-CsDatabase.md b/skype/skype-ps/skype/Install-CsDatabase.md index 8aea82ff56..cfa2fa1de6 100644 --- a/skype/skype-ps/skype/Install-CsDatabase.md +++ b/skype/skype-ps/skype/Install-CsDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/install-csdatabase +online version: https://learn.microsoft.com/powershell/module/skype/install-csdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Install-CsDatabase schema: 2.0.0 @@ -637,5 +637,3 @@ The Install-CsDatabase cmdlet does not return any values or objects. ## RELATED LINKS [Uninstall-CsDatabase](Uninstall-CsDatabase.md) - - diff --git a/skype/skype-ps/skype/Install-CsMirrorDatabase.md b/skype/skype-ps/skype/Install-CsMirrorDatabase.md index 1b351cadf2..feb4acc5d3 100644 --- a/skype/skype-ps/skype/Install-CsMirrorDatabase.md +++ b/skype/skype-ps/skype/Install-CsMirrorDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/install-csmirrordatabase +online version: https://learn.microsoft.com/powershell/module/skype/install-csmirrordatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Install-CsMirrorDatabase schema: 2.0.0 @@ -361,4 +361,3 @@ None. [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md b/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md index f432d14e74..dbb310849d 100644 --- a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md +++ b/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csarchivingdatabasepurge +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csarchivingdatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsArchivingDatabasePurge schema: 2.0.0 @@ -278,4 +278,3 @@ The Invoke-CsArchivingDatabasePurge cmdlet returns instances of the Microsoft.Rt [New-CsArchivingConfiguration](New-CsArchivingConfiguration.md) [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) - diff --git a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md b/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md index e2a9c0c2dd..4c9944e54e 100644 --- a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md +++ b/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csbackupservicesync +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csbackupservicesync applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsBackupServiceSync schema: 2.0.0 @@ -130,4 +130,3 @@ None. ## RELATED LINKS [Backup-CsPool](Backup-CsPool.md) - diff --git a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md b/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md index c9921e5925..1aff964a92 100644 --- a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md +++ b/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-cscdrdatabasepurge +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscdrdatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsCdrDatabasePurge schema: 2.0.0 @@ -269,4 +269,3 @@ The Invoke-CsCdrDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Mana [New-CsCdrConfiguration](New-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md b/skype/skype-ps/skype/Invoke-CsComputerFailBack.md index de46ceda78..2700d5b25c 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md +++ b/skype/skype-ps/skype/Invoke-CsComputerFailBack.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-cscomputerfailback +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailback applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsComputerFailBack schema: 2.0.0 @@ -184,4 +184,3 @@ None. ## RELATED LINKS [Invoke-CsComputerFailOver](Invoke-CsComputerFailOver.md) - diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md b/skype/skype-ps/skype/Invoke-CsComputerFailOver.md index 340ea429fd..723b08653b 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md +++ b/skype/skype-ps/skype/Invoke-CsComputerFailOver.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-cscomputerfailover +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailover applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsComputerFailOver schema: 2.0.0 @@ -225,4 +225,3 @@ None. ## RELATED LINKS [Invoke-CsComputerFailBack](Invoke-CsComputerFailBack.md) - diff --git a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md b/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md index a0780694b8..95e2fcf516 100644 --- a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md +++ b/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csdatabasefailover +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csdatabasefailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsDatabaseFailover schema: 2.0.0 @@ -276,4 +276,3 @@ None. [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md b/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md index 502f7d20ea..342f852532 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md +++ b/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csmanagementserverfailover +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementserverfailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsManagementServerFailover schema: 2.0.0 @@ -250,4 +250,3 @@ None. ## RELATED LINKS [Invoke-CsDatabaseFailover](Invoke-CsDatabaseFailover.md) - diff --git a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md b/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md index 2c495d4bed..c002ae71c5 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md +++ b/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csmanagementstorereplication +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementstorereplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsManagementStoreReplication schema: 2.0.0 @@ -125,5 +125,3 @@ The Invoke-CsManagementStoreReplication cmdlet does not return any objects. ## RELATED LINKS [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) - - diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md b/skype/skype-ps/skype/Invoke-CsPoolFailBack.md index e24c6571f0..99b453decd 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md +++ b/skype/skype-ps/skype/Invoke-CsPoolFailBack.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-cspoolfailback +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailback applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsPoolFailBack schema: 2.0.0 @@ -222,4 +222,3 @@ None. ## RELATED LINKS [Invoke-CsPoolFailOver](Invoke-CsPoolFailOver.md) - diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md b/skype/skype-ps/skype/Invoke-CsPoolFailOver.md index 24ea224644..45d8e8e11f 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md +++ b/skype/skype-ps/skype/Invoke-CsPoolFailOver.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-cspoolfailover +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsPoolFailOver schema: 2.0.0 @@ -112,7 +112,7 @@ When present, indicates that failover is being performed in "disaster mode." If If this parameter is not present that means that the pool is still up and running and that failover occurred by administrator choice; for example, the pool might temporarily be failed over in order to do hardware or software upgrades on the server. -Note: The parameteris required for an Enterprise pool if the backend SQL services are down but the front end servers are still up. +Note: The parameters required for an Enterprise pool if the backend SQL services are down but the front end servers are still up. @@ -264,4 +264,3 @@ None. ## RELATED LINKS [Invoke-CsPoolFailBack](Invoke-CsPoolFailBack.md) - diff --git a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md b/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md index 4e2bab4bb8..573235dd3b 100644 --- a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md +++ b/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csqoedatabasepurge +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csqoedatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsQoEDatabasePurge schema: 2.0.0 @@ -237,4 +237,3 @@ The Invoke-CsQoEDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Mana [New-CsQoEConfiguration](New-CsQoEConfiguration.md) [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md b/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md index 17ee8e0198..a62fee6b1d 100644 --- a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md +++ b/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csrgsstorereplicatedata +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csrgsstorereplicatedata applicable: Skype for Business Server 2019 title: Invoke-CsRGSStoreReplicateData schema: 2.0.0 diff --git a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md b/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md index f15d74d3cc..90e2298abf 100644 --- a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md +++ b/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csstorageserviceflush +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csstorageserviceflush applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsStorageServiceFlush schema: 2.0.0 @@ -198,4 +198,3 @@ String value. ## RELATED LINKS [Invoke-CsPoolFailOver](Invoke-CsPoolFailOver.md) - diff --git a/skype/skype-ps/skype/Invoke-CsUcsRollback.md b/skype/skype-ps/skype/Invoke-CsUcsRollback.md index f1ae1d3da3..b0d139bbd3 100644 --- a/skype/skype-ps/skype/Invoke-CsUcsRollback.md +++ b/skype/skype-ps/skype/Invoke-CsUcsRollback.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/invoke-csucsrollback -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csucsrollback +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsUcsRollback schema: 2.0.0 manager: bulenteg @@ -236,4 +236,3 @@ None. [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) [Test-CsUnifiedContactStore](Test-CsUnifiedContactStore.md) - diff --git a/skype/skype-ps/skype/Lock-CsClientPin.md b/skype/skype-ps/skype/Lock-CsClientPin.md index 24e0c3bf33..4e7c015374 100644 --- a/skype/skype-ps/skype/Lock-CsClientPin.md +++ b/skype/skype-ps/skype/Lock-CsClientPin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/lock-csclientpin +online version: https://learn.microsoft.com/powershell/module/skype/lock-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Lock-CsClientPin schema: 2.0.0 @@ -179,4 +179,3 @@ Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Manage [Set-CsClientPin](Set-CsClientPin.md) [Unlock-CsClientPin](Unlock-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Merge-CsLegacyTopology.md b/skype/skype-ps/skype/Merge-CsLegacyTopology.md index 59622383f3..c472df4e40 100644 --- a/skype/skype-ps/skype/Merge-CsLegacyTopology.md +++ b/skype/skype-ps/skype/Merge-CsLegacyTopology.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/merge-cslegacytopology +online version: https://learn.microsoft.com/powershell/module/skype/merge-cslegacytopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Merge-CsLegacyTopology schema: 2.0.0 @@ -239,4 +239,3 @@ The Merge-CsLegacyTopology cmdlet does not return any objects or values. [Import-CsLegacyConferenceDirectory](Import-CsLegacyConferenceDirectory.md) [Move-CsLegacyUser](Move-CsLegacyUser.md) - diff --git a/skype/skype-ps/skype/Move-CsAnalogDevice.md b/skype/skype-ps/skype/Move-CsAnalogDevice.md index c488118641..70102968cd 100644 --- a/skype/skype-ps/skype/Move-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Move-CsAnalogDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skype/move-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsAnalogDevice schema: 2.0.0 @@ -322,4 +322,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md b/skype/skype-ps/skype/Move-CsApplicationEndpoint.md index f14fa25328..1947fce031 100644 --- a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md +++ b/skype/skype-ps/skype/Move-CsApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/move-csapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsApplicationEndpoint schema: 2.0.0 @@ -218,4 +218,3 @@ When used with the PassThru parameter, returns an object of type Microsoft.Rtc.M ## RELATED LINKS [Get-CsApplicationEndpoint](Get-CsApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md b/skype/skype-ps/skype/Move-CsCommonAreaPhone.md index 98d6d08545..55cd8f84f2 100644 --- a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Move-CsCommonAreaPhone.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skype/move-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsCommonAreaPhone schema: 2.0.0 @@ -332,4 +332,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Move-CsConferenceDirectory.md b/skype/skype-ps/skype/Move-CsConferenceDirectory.md index 229a453c5b..239a0646db 100644 --- a/skype/skype-ps/skype/Move-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/Move-CsConferenceDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skype/move-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsConferenceDirectory schema: 2.0.0 @@ -191,4 +191,3 @@ None. [New-CsConferenceDirectory](New-CsConferenceDirectory.md) [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) - diff --git a/skype/skype-ps/skype/Move-CsExUmContact.md b/skype/skype-ps/skype/Move-CsExUmContact.md index 2e92cea44b..fd94b648a5 100644 --- a/skype/skype-ps/skype/Move-CsExUmContact.md +++ b/skype/skype-ps/skype/Move-CsExUmContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skype/move-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsExUmContact schema: 2.0.0 @@ -304,4 +304,3 @@ When called with the PassThru parameter, returns an object of type Microsoft.Rtc [Set-CsExUmContact](Set-CsExUmContact.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Move-CsLegacyUser.md b/skype/skype-ps/skype/Move-CsLegacyUser.md index 7ea473df4a..9bc5c5ed52 100644 --- a/skype/skype-ps/skype/Move-CsLegacyUser.md +++ b/skype/skype-ps/skype/Move-CsLegacyUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-cslegacyuser +online version: https://learn.microsoft.com/powershell/module/skype/move-cslegacyuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsLegacyUser schema: 2.0.0 @@ -419,4 +419,3 @@ Instead, the cmdlet moves instances of the Microsoft.Rtc.Management.ADConnect.Sc [Move-CsUser](Move-CsUser.md) [Set-CsUser](Set-CsUser.md) - diff --git a/skype/skype-ps/skype/Move-CsManagementServer.md b/skype/skype-ps/skype/Move-CsManagementServer.md index 84cd157e8a..5e869c100f 100644 --- a/skype/skype-ps/skype/Move-CsManagementServer.md +++ b/skype/skype-ps/skype/Move-CsManagementServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csmanagementserver +online version: https://learn.microsoft.com/powershell/module/skype/move-csmanagementserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsManagementServer schema: 2.0.0 @@ -254,5 +254,3 @@ The Move-CsManagementServer cmdlet does not return any objects. ## RELATED LINKS [Set-CsManagementServer](Set-CsManagementServer.md) - - diff --git a/skype/skype-ps/skype/Move-CsMeetingRoom.md b/skype/skype-ps/skype/Move-CsMeetingRoom.md index b428dea652..25aefd9c8e 100644 --- a/skype/skype-ps/skype/Move-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Move-CsMeetingRoom.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csmeetingroom +online version: https://learn.microsoft.com/powershell/module/skype/move-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsMeetingRoom schema: 2.0.0 @@ -42,7 +42,7 @@ In Skype for Business Server 2015, meeting rooms are self-contained computer app * Calendar integration to provide access to scheduled meetings * Content sharing and switching -In order to manage these new endpoint devices you must, among other things, create and enable a Exchange resource mailbox account for the device, then enable that resource account for Skype for Business Server 2015. +In order to manage these new endpoint devices you must, among other things, create and enable an Exchange resource mailbox account for the device, then enable that resource account for Skype for Business Server 2015. Note that, for Skype for Business Server 2015, there are no cmdlets for creating or removing meeting rooms. Instead, you use the Enable-CsMeetingRoom cmdlet to enable meeting rooms and the Disable-CsMeetingRoom cmdlet to disable meeting rooms. The resource account must already exist in order for you to enable the meeting room, and disabling a meeting room only removes that room from your collection of meeting rooms; it does not delete the resource mailbox account. @@ -320,5 +320,3 @@ None. [Get-CsMeetingRoom](Get-CsMeetingRoom.md) [Set-CsMeetingRoom](Set-CsMeetingRoom.md) - - diff --git a/skype/skype-ps/skype/Move-CsRgsConfiguration.md b/skype/skype-ps/skype/Move-CsRgsConfiguration.md index 04125b4526..c0b6514042 100644 --- a/skype/skype-ps/skype/Move-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Move-CsRgsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/move-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsRgsConfiguration schema: 2.0.0 @@ -28,7 +28,7 @@ When someone calls a designated phone number, that call can be automatically rou Alternatively, the call might be routed to an interactive voice response (IVR) queue. In that queue, the caller would be asked a series of questions (for example, "Are you calling about an existing order?") and then, based on the answers to those questions, be given the asked-for information or be routed to a Response Group agent. -If you are currently running the Response Group application on legacy server, the Move-CsRgsConfiguration cmdlet provides a way for you to migrate this service to newer vesion server. +If you are currently running the Response Group application on legacy server, the Move-CsRgsConfiguration cmdlet provides a way for you to migrate this service to newer version server. To migrate the service, you need to call the Move-CsRgsConfiguration cmdlet and specify: 1) the fully qualified domain name (FQDN) for the existing version of the Response Group application (the Source); and, 2) the FQDN for the new Skype for Business Server version of the service (the Destination). Move-CsRgsConfiguration will then move all the configuration settings, audio files, and contact objects from the existing version (for example, Office Communications Server 2007 R2 or Lync Server 2010) to newer version. After the service has been migrated, all calls to a Response Group phone number will be handled by the newer server. @@ -142,6 +142,3 @@ Move-CsRgsConfiguration moves instances of the Microsoft.Rtc.Management.Writable [Get-CsRgsConfiguration](Get-CsRgsConfiguration.md) [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) - - - diff --git a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md index e3623e8b51..6ab001cf5a 100644 --- a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skype/move-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsThirdPartyVideoSystem schema: 2.0.0 @@ -290,4 +290,3 @@ However, if you include the PassThru parameter you can instances of the Microsof [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/Move-CsUser.md b/skype/skype-ps/skype/Move-CsUser.md index 45ee2b4901..29973fc914 100644 --- a/skype/skype-ps/skype/Move-CsUser.md +++ b/skype/skype-ps/skype/Move-CsUser.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/move-csuser -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/move-csuser +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Move-CsUser schema: 2.0.0 manager: rogupta @@ -14,20 +14,29 @@ ms.reviewer: ## SYNOPSIS -Moves one or more user accounts enabled for Skype for Business Server to TeamsOnly (or the reverse). This cmdlet also can be used to move on-premises users from one pool to another. +Moves one or more user accounts enabled for Skype for Business Server to TeamsOnly (or the reverse). This cmdlet also can be used to move on-premises users from one pool to another. + +**PRE-REQUISITES steps for running Move-CsUser** +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later + +**PRE-REQUISITES steps for** [Office 365 operated by 21Vianet](/microsoft-365/admin/services-in-china/services-in-china?view=o365-21vianet) +- Install or update the Microsoft Teams PowerShell module to version 6.2.1 or later +- Run Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/set-teamsenvironmentconfig). ## SYNTAX ### (Default) ``` -Move-CsUser [-Identity] [-Target] [-Credential ] [-MoveToTeams] [-HostedMigrationOverrideUrl ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] +Move-CsUser [-Identity] [-Target] [-Credential ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] ``` ### UserList ``` -Move-CsUser -UserList [-Target] [-Credential ] [-MoveToTeams] [-HostedMigrationOverrideUrl ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] +Move-CsUser -UserList [-Target] [-Credential ] [-UseOAuth] [-BypassEnterpriseVoiceCheck] [-BypassAudioConferencingCheck] [-TenantAdminUserName] [-ProxyPool ] [-MoveConferenceData] [-Report ] [-DomainController ] [-Confirm] [-Force] [-PassThru] [-WhatIf] [] ``` ## DESCRIPTION @@ -41,16 +50,19 @@ The Move-CsUser cmdlet affects only the user's Skype for Business Server account When moving a user to the Microsoft 365 cloud to become TeamsOnly (or the reverse): -- Skype for Business hybrid must be configured. For more information, see [Deploy hybrid connectivity between Skype for Business Server and Skype for Business Online](https://docs.microsoft.com/SkypeForBusiness/skype-for-business-hybrid-solutions/deploy-hybrid-connectivity/deploy-hybrid-connectivity). +- Skype for Business hybrid must be configured. For more information, see [Deploy hybrid connectivity between Skype for Business Server and Skype for Business Online](https://learn.microsoft.com/SkypeForBusiness/skype-for-business-hybrid-solutions/deploy-hybrid-connectivity/deploy-hybrid-connectivity). - To move a user to Microsoft 365, specify the ProxyFqdn of the hosting provider as the Target. In most cases, this is "sipfed.online.lync.com" but in specialized environments, there will be variants of this address. For more details, see [Move users between on-premises and cloud](/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud). -- When migrating from on-premises to the cloud, users are automatically assigned TeamsOnly mode and their meetings from on-premises are automatically converted to Teams meetings. This happens regardless of which on-premises version of Skype for Business Server or Lync Server is used. It is no longer necessary to specify the `-MoveToTeams` switch, and specifying this switch no longer has any impact. Teams-only users can still *join* meetings hosted in Skype for Business (which may happen if they are invited to a meeting by a user that is using Skype For Business). -- When migrating from on-premises to the cloud, contacts from Skype for Business Server are migrated to the cloud (unless -force switch is used in move-csuser) and become available in Teams after the user logs on to Teams after the move. +- When migrating from on-premises to the cloud, users are automatically assigned Teams Only mode and their meetings from on-premises are automatically converted to Teams meetings. This conversion happens regardless of which on-premises version of Skype for Business Server or Lync Server was being used. You no longer need to specify the `-MoveToTeams` switch. In fact, specifying that switch no longer has any impact. Teams Only users can still *join* meetings hosted in Skype for Business (for example, they're invited to a meeting by a Skype For Business user). However, beginning in October 2022, users moved from on-premises to Teams Only will no longer be provisioned with the Skype for Business Online infrastructure. At this point, Teams Only users can join Skype for Business meetings, but only anonymously. For more information, see [Skype for Business Online retirement](/microsoftteams/skype-for-business-online-retirement). +- When migrating from on-premises to the cloud, contacts from Skype for Business Server are migrated to the cloud (unless you use the `-Force` switch in the Move-CsUser command) and become available in Teams after the move is complete and the user logs on to Teams. To ensure these contacts are migrated to Teams, the migrated user must sign in to Teams within 30 days of being moved from on-premises to Teams Only. For details, see [Guidance for Organizations with on-premises deployments of Skype for Business Server](/microsoftteams/skype-for-business-online-retirement#guidance-for-organizations-with-on-premises-deployments-of-skype-for-business-server). - If you receive an error while running this cmdlet about multiple federated Edge pools, Skype for Business Federation can only be enabled for a single Edge pool. If you have multiple Edge pools, select one to use as the federating Edge pool. > [!NOTE] > > - Moving users from On-Premises to Teams requires TLS 1.2. TLS 1.0 and TLS 1.1 have been deprecated. Please visit [Disabling TLS 1.0 and 1.1 for Microsoft 365](/microsoft-365/compliance/tls-1.0-and-1.1-deprecation-for-office-365?view=o365-worldwide) and [Preparing for TLS 1.2 in Office 365 and Office 365 GCC](/microsoft-365/compliance/prepare-tls-1.2-in-office-365?view=o365-worldwide) for details. -> - To use Multi-Factor Authentication (MFA) with Move-CsUser requires either Skype for Business Server 2015 CU12 or any version of Skype for Business Server 2019. When using MFA do not specify the -Credential paremeter. If you are using an earlier version of Skype for Business Server, you should either disable MFA and use the credential parameter, or obtain a newer version of the administrative tools for Skype for Business Server that supports MFA. +> - To use Multi-Factor Authentication (MFA) with Move-CsUser requires either Skype for Business Server 2015 CU12 or any version of Skype for Business Server 2019. When using MFA do not specify the -Credential parameter. If you are using an earlier version of Skype for Business Server, you should either disable MFA and use the credential parameter, or obtain a newer version of the administrative tools for Skype for Business Server that supports MFA. + +> [!NOTE] +> As of November 10, 2023, moving users from Teams to On-Premises will no longer migrate their contacts. This is mainly due to our continuous efforts to tighten security and protect customers' data. After carefully analyzing the usage patterns and performing risk assessments with the legacy infrastructure, we decided to deprecate this feature. **MINIMUM REQUIRED SERVER VERSIONS**: @@ -104,7 +116,7 @@ To carry out this task, the command first uses the Get-CsUser cmdlet and the OU Move-CsUser -UserList C:\Folder1\Folder2\file1.txt -Target "atl-cs-001.litwareinc.com" -Report C:\Folder1\Folder2\out.csv ``` -In Example 5, all the users listed in file1.txt are moved to the the Registrar pool atl-cs-001.litwareinc.com. +In Example 5, all the users listed in file1.txt are moved to the Registrar pool atl-cs-001.litwareinc.com. Also, a detailed report is created in the out.csv file. ## PARAMETERS @@ -150,22 +162,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MoveToTeams - -This parameter is no longer needed. This parameter is only available with Skype for Business Server 2019 and CU8 for Skype for Business Server 2015 and previously was required to move a user *directly* to TeamsOnly in Microsoft 365. However, when using Move-CsUser, users are now always moved to TeamsOnly, whether this switch is specified or not. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Enables you to run the Move-CsUser cmdlet under alternate credentials, which is typically required when moving to Office 365. To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet help topic. @@ -183,26 +179,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedMigrationOverrideUrl - -The hosted migration service is the service in Office 365 that performs user moves. By default, there is no need to specify a value for this parameter, as long as the hosting provider has its AutoDiscover URL properly configured and you are using an admin account the ends in .onmicrosoft.com. If you are using a user account from on-premises that synchronized to the cloud, you must specify this parameter. See [Required administrative credentials](/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud#required-administrative-credentials). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -UseOAuth -This switch is only relevant for Skype for Business Server 2015 with CU8 up to CU11. When using those versions, this switch is now *required*. It ensures authentication between on-premises and the host migration service is based on OAuth protocol. In Skype for Business Server 2019 as well as Skype for Business Server 2015 CU12 and later, OAuth is always used hence the switch is not relevant on those versions. +This switch is no longer relevant. Previously, this switch ensured authentication between on-premises and the cloud. This switch also ensured Skype for Business Server 2015 CU8 to CU11 used the OAuth protocol (supported in those versions, but not used by default). All currently supported versions for migration to Teams (see the list earlier in this article) automatically use OAuth, so this switch is no longer required. ```yaml Type: SwitchParameter @@ -265,7 +244,7 @@ Accept wildcard characters: False ### -ProxyPool -This parameter has been deprecated and should not be used. +This is an optional parameter that can be used to specify the front-end pool for user migration. ```yaml Type: Fqdn @@ -450,10 +429,12 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.ADConnect ## RELATED LINKS -[Move users between on-premises and cloud](https://docs.microsoft.com/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud) +[Move users between on-premises and cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud) + +[Configure Skype for Business hybrid](https://learn.microsoft.com/SkypeForBusiness/hybrid/configure-federation-with-skype-for-business-online) -[Skype for Business Hybrid Solutions](https://docs.microsoft.com/SkypeForBusiness/skype-for-business-hybrid-solutions/skype-for-business-hybrid-solutions) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) -[Using the Meeting Migration Service (MMS)](https://docs.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) +[Guidance for Organizations with on-premises deployments of Skype for Business Server](https://learn.microsoft.com/microsoftteams/skype-for-business-online-retirement#guidance-for-organizations-with-on-premises-deployments-of-skype-for-business-server) diff --git a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md index 17852612cf..89161bbc99 100644 --- a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAVEdgeConfiguration schema: 2.0.0 @@ -247,4 +247,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.M [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md b/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md index c079e057ec..02cf488052 100644 --- a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain +online version: https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAdditionalInternalDomain schema: 2.0.0 @@ -158,7 +158,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Remove-CsAdditionalInternalDomain](https://docs.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain?view=skype-ps) - -[Get-CsAdditionalInternalDomain](https://docs.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Remove-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md b/skype/skype-ps/skype/New-CsAddressBookConfiguration.md index 8b840efd27..2e6b1c092e 100644 --- a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/New-CsAddressBookConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAddressBookConfiguration schema: 2.0.0 @@ -417,5 +417,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Addres [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md index e419a2fce0..3291177ad9 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAddressBookNormalizationConfiguration schema: 2.0.0 @@ -175,5 +175,3 @@ The New-CsAddressBookNormalizationConfiguration cmdlet creates new instances of [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - - diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md index 494f56d48c..9aa677a96c 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAddressBookNormalizationRule schema: 2.0.0 @@ -282,4 +282,3 @@ The New-CsAddressBookNormalizationRule cmdlet creates instances of the Microsoft [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/New-CsAdminRole.md b/skype/skype-ps/skype/New-CsAdminRole.md index 36e2214873..afa8e62603 100644 --- a/skype/skype-ps/skype/New-CsAdminRole.md +++ b/skype/skype-ps/skype/New-CsAdminRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csadminrole +online version: https://learn.microsoft.com/powershell/module/skype/new-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAdminRole schema: 2.0.0 @@ -366,4 +366,3 @@ The New-CsAdminRole cmdlet creates new instances of the Microsoft.Rtc.Management ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsAllowedDomain.md b/skype/skype-ps/skype/New-CsAllowedDomain.md index 3353e6c901..4bd2464f78 100644 --- a/skype/skype-ps/skype/New-CsAllowedDomain.md +++ b/skype/skype-ps/skype/New-CsAllowedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skype/new-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAllowedDomain schema: 2.0.0 @@ -325,5 +325,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.A [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsAllowedDomain](Set-CsAllowedDomain.md) - - diff --git a/skype/skype-ps/skype/New-CsAnalogDevice.md b/skype/skype-ps/skype/New-CsAnalogDevice.md index e25e2a27c7..78fd82666f 100644 --- a/skype/skype-ps/skype/New-CsAnalogDevice.md +++ b/skype/skype-ps/skype/New-CsAnalogDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skype/new-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAnalogDevice schema: 2.0.0 @@ -306,4 +306,3 @@ The New-CsAnalogDevice cmdlet creates new instances of the Microsoft.Rtc.Managem [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/New-CsAnnouncement.md b/skype/skype-ps/skype/New-CsAnnouncement.md index a69ceb3e17..5d2ff20332 100644 --- a/skype/skype-ps/skype/New-CsAnnouncement.md +++ b/skype/skype-ps/skype/New-CsAnnouncement.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csannouncement +online version: https://learn.microsoft.com/powershell/module/skype/new-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAnnouncement schema: 2.0.0 @@ -360,4 +360,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Annou [New-CsUnassignedNumber](New-CsUnassignedNumber.md) [Set-CsUnassignedNumber](Set-CsUnassignedNumber.md) - diff --git a/skype/skype-ps/skype/New-CsArchivingConfiguration.md b/skype/skype-ps/skype/New-CsArchivingConfiguration.md index e0bfea4da0..16ef9e0722 100644 --- a/skype/skype-ps/skype/New-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/New-CsArchivingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsArchivingConfiguration schema: 2.0.0 @@ -384,4 +384,3 @@ The New-CsArchivingConfiguration cmdlet creates new instances of the Microsoft.R [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/New-CsArchivingPolicy.md b/skype/skype-ps/skype/New-CsArchivingPolicy.md index cefdc13ced..1abff2dd90 100644 --- a/skype/skype-ps/skype/New-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/New-CsArchivingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsArchivingPolicy schema: 2.0.0 @@ -279,5 +279,3 @@ The New-CsArchivingPolicy cmdlet creates instances of the Microsoft.Rtc.Manageme [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md index 38c77c42ec..0e9d77cb0a 100644 --- a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsAutodiscoverConfiguration schema: 2.0.0 manager: rogupta @@ -74,7 +74,7 @@ $Link2 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscoverInternal.fab New-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1,$Link2} ``` -The commands shown in Example 2 create a new collection of Autodiscover configuration settings for the Redmond site and assign those new settings a pair of Autodiscover URLs: https://LyncDiscover.fabrikam.com and https://LyncDiscoverInternal.fabrikam.com. +The commands shown in Example 2 create a new collection of Autodiscover configuration settings for the Redmond site and assign those new settings a pair of Autodiscover URLs: `https://LyncDiscover.fabrikam.com` and `https://LyncDiscoverInternal.fabrikam.com`. In order to carry out this task, the first two commands use the New-CsWebLink cmdlet to create the two Autodiscover URLs; the newly-created URLs are then stored in variables named $Link1 and $Link2. After the two URLs are created, the third command uses the New-CsAutoDiscoverConfiguration cmdlet to create the new Autodiscover configuration settings. In order to assign the two URLs to these settings, the WebLinks parameter is included along with the parameter value @{Add=$Link1,$Link2}. @@ -251,4 +251,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.A ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md index 249c7c1f36..3a2dc9990e 100644 --- a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsBandwidthPolicyServiceConfiguration schema: 2.0.0 @@ -248,4 +248,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Bandw [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsBlockedDomain.md b/skype/skype-ps/skype/New-CsBlockedDomain.md index 4fdce3e023..4b9231b7d5 100644 --- a/skype/skype-ps/skype/New-CsBlockedDomain.md +++ b/skype/skype-ps/skype/New-CsBlockedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skype/new-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsBlockedDomain schema: 2.0.0 @@ -242,5 +242,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.B [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsBlockedDomain](Set-CsBlockedDomain.md) - - diff --git a/skype/skype-ps/skype/New-CsCallParkOrbit.md b/skype/skype-ps/skype/New-CsCallParkOrbit.md index f335a62a13..fb35a67100 100644 --- a/skype/skype-ps/skype/New-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/New-CsCallParkOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skype/new-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsCallParkOrbit schema: 2.0.0 @@ -287,5 +287,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.Voice.Helpers.Dis [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) - - diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md deleted file mode 100644 index 6abc75e8dd..0000000000 --- a/skype/skype-ps/skype/New-CsCallQueue.md +++ /dev/null @@ -1,543 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscallqueue -applicable: Skype for Business Online -title: New-CsCallQueue -author: tomkau -ms.author: tomkau -manager: bulenteg -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsCallQueue - -## SYNOPSIS -Creates new Call Queue in your Skype for Business Online organization. - -## SYNTAX - -``` -New-CsCallQueue -Name [-AgentAlertTime ] [-AllowOptOut ] [-DistributionLists ] -[-Tenant ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-MusicOnHoldAudioFileId ] -[-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] -[-TimeoutAction ] [-TimeoutActionTarget ] [-TimeoutThreshold ] -[-RoutingMethod ] [-PresenceBasedRouting ] [-ConferenceMode ] [-User ] [-LanguageId ] [-LineUri ] [-OboResourceAccountIds ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] -[-ChannelId ] [-ChannelUserObjectId ] [] -``` - -## DESCRIPTION -The New-CsCallQueue cmdlet creates a new Call Queue. - -## EXAMPLES - -### Example 1 -``` -New-CsCallQueue -Name "Help Desk" -UseDefaultMusicOnHold $true -``` - -This example creates a Call Queue for the organization named "Help Desk" using default music on hold. - -### Example 2 -``` -New-CsCallQueue -Name "Help desk" -RoutingMethod Attendant -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -AllowOptOut $false -AgentAlertTime 30 -OverflowThreshold 15 -OverflowAction Forward -OverflowActionTarget 7fd04db1-1c8e-4fdf-9af5-031514ba1358 -TimeoutThreshold 30 -TimeoutAction Disconnect -MusicOnHoldAudioFileId 1e81adaf-7c3e-4db1-9d61-5d135abb1bcc -WelcomeMusicAudioFileId 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 - -``` - -This example creates a Call Queue for the organization named "Help Desk" with music on hold and welcome music audio files. - - -## PARAMETERS - -### -Name -The Name parameter specifies a unique name for the Call Queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentAlertTime -The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 30 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOptOut -The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldAudioFileId -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. - -Only Call Queue managed by a Teams Channel will be able to use this feature. For more information, please refer to [Manage your support Call Queue in Teams](https://support.microsoft.com/office/manage-your-support-call-queue-in-teams-9f07dabe-91c6-4a9b-a545-8ffdddd2504e). - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. - -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: DisconnectWithBusy -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this parameter is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 50 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. - -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Attendant -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. - -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Disconnect -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 1200 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: - -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. - -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LanguageId -The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. - -You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LineUri -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelId -Id of the channel to connect a call queue to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelUserObjectId -Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS -[Create a Phone System Call Queue](https://support.office.com/article/Create-a-Phone-System-call-queue-67ccda94-1210-43fb-a25b-7b9785f8a061) diff --git a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md index 43960ce027..cc14b7f786 100644 --- a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsCallViaWorkPolicy schema: 2.0.0 @@ -225,5 +225,3 @@ The New-CsCallViaWorkPolicy returns Microsoft.Rtc.Management.WritableConfig.Poli [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsCdrConfiguration.md b/skype/skype-ps/skype/New-CsCdrConfiguration.md index da1c62d592..68b89ad829 100644 --- a/skype/skype-ps/skype/New-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/New-CsCdrConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsCdrConfiguration schema: 2.0.0 @@ -291,5 +291,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDe [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsClientPolicy.md b/skype/skype-ps/skype/New-CsClientPolicy.md index c143b983ee..38bddfb4fe 100644 --- a/skype/skype-ps/skype/New-CsClientPolicy.md +++ b/skype/skype-ps/skype/New-CsClientPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclientpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClientPolicy schema: 2.0.0 manager: bulenteg @@ -1353,11 +1353,9 @@ To search only last name, first name, and display name you would construct this 1110000 After the binary value has been constructed, it must then be converted to a decimal value before being assigned to SearchPrefixFlags. -To convert a binary number to a decimal number, you can use the a Windows PowerShell command similar to this: - -`\[Convert\]::ToInt32("1110111", 2)` - +To convert a binary number to a decimal number, you can use a Windows PowerShell command similar to this: +`[Convert]::ToInt32("1110111", 2)` ```yaml Type: UInt16 @@ -2145,5 +2143,3 @@ The New-CsClientPolicy cmdlet creates new instances of the Microsoft.Rtc.Managem [Remove-CsClientPolicy](Remove-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsClientPolicyEntry.md b/skype/skype-ps/skype/New-CsClientPolicyEntry.md index 3e27fd372b..4fb43fb573 100644 --- a/skype/skype-ps/skype/New-CsClientPolicyEntry.md +++ b/skype/skype-ps/skype/New-CsClientPolicyEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclientpolicyentry +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicyentry applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClientPolicyEntry schema: 2.0.0 @@ -174,4 +174,3 @@ The New-CsClientPolicyEntry cmdlet creates new instances of the Microsoft.Rtc.Ma [New-CsClientPolicy](New-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md b/skype/skype-ps/skype/New-CsClientVersionConfiguration.md index c948acfd54..a361347d9f 100644 --- a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/New-CsClientVersionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClientVersionConfiguration schema: 2.0.0 @@ -268,5 +268,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Clie [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicy.md b/skype/skype-ps/skype/New-CsClientVersionPolicy.md index f24b62fbf8..d8e270a440 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/New-CsClientVersionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClientVersionPolicy schema: 2.0.0 @@ -262,4 +262,3 @@ The New-CsClientVersionPolicy cmdlet creates new instances of the Microsoft.Rtc. [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md index 8a56e3445a..2cb0dc194e 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClientVersionPolicyRule schema: 2.0.0 @@ -90,7 +90,7 @@ Client version policies enforced in your organization do not override the client ### -------------------------- EXAMPLE 1 -------------------------- ``` -$x = \[guid\]::NewGuid() +$x = [guid]::NewGuid() New-CsClientVersionPolicyRule -Parent "site:Redmond" -RuleId $x -MajorVersion 4 -UserAgent InHouse ``` @@ -108,7 +108,7 @@ In this case, the UserAgent parameter represents an in-house client application. ### -------------------------- EXAMPLE 2 -------------------------- ``` -$x = \[guid\]::NewGuid() +$x = [guid]::NewGuid() $z = New-CsClientVersionPolicyRule -Parent "site:Redmond" -RuleId $x -InMemory @@ -407,7 +407,7 @@ Accept wildcard characters: False Globally unique identifier (GUID) for the rule. In Windows PowerShell, you can create a GUID by using the following command: -`$x = \[guid\]::NewGuid()` +`$x = [guid]::NewGuid()` ```yaml Type: String @@ -556,5 +556,3 @@ The New-CsClientVersionPolicyRule cmdlet creates new instances of Microsoft.Rtc. [Remove-CsClientVersionPolicyRule](Remove-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - - diff --git a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md index 0085f60ebe..9508f13493 100644 --- a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscloudcalldataconnectorconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 title: New-CsCloudCallDataConnectorConfiguration schema: 2.0.0 diff --git a/skype/skype-ps/skype/New-CsClsConfiguration.md b/skype/skype-ps/skype/New-CsClsConfiguration.md index 7a75aa82c8..123753063b 100644 --- a/skype/skype-ps/skype/New-CsClsConfiguration.md +++ b/skype/skype-ps/skype/New-CsClsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsClsConfiguration schema: 2.0.0 @@ -494,4 +494,3 @@ The New-CsClsConfiguration cmdlet creates new instances of the icrosoft.Rtc.Mana [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) [Set-CsClsConfiguration](Set-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsClsProvider.md b/skype/skype-ps/skype/New-CsClsProvider.md index baa432885a..33da9f6a09 100644 --- a/skype/skype-ps/skype/New-CsClsProvider.md +++ b/skype/skype-ps/skype/New-CsClsProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclsprovider +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -220,4 +220,3 @@ The New-CsClsProvider cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsClsScenario](New-CsClsScenario.md) [Set-CsClsScenario](Set-CsClsScenario.md) - diff --git a/skype/skype-ps/skype/New-CsClsRegion.md b/skype/skype-ps/skype/New-CsClsRegion.md index 5852430fde..e25b134904 100644 --- a/skype/skype-ps/skype/New-CsClsRegion.md +++ b/skype/skype-ps/skype/New-CsClsRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclsregion +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -271,6 +271,3 @@ The New-CsClsRegion cmdlet creates new instances of the Microsoft.Rtc.Management [Remove-CsClsRegion](Remove-CsClsRegion.md) [Set-CsClsRegion](Set-CsClsRegion.md) - - - diff --git a/skype/skype-ps/skype/New-CsClsScenario.md b/skype/skype-ps/skype/New-CsClsScenario.md index 56ca60f412..c8ab273146 100644 --- a/skype/skype-ps/skype/New-CsClsScenario.md +++ b/skype/skype-ps/skype/New-CsClsScenario.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -256,6 +256,3 @@ The New-CsClsScenario cmdlet creates new instances of the Microsoft.Rtc.Manageme ## NOTES ## RELATED LINKS - - - diff --git a/skype/skype-ps/skype/New-CsClsSecurityGroup.md b/skype/skype-ps/skype/New-CsClsSecurityGroup.md index ab36d84ad4..6e4d1cada3 100644 --- a/skype/skype-ps/skype/New-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/New-CsClsSecurityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skype/new-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -241,4 +241,3 @@ The New-CsClsSecurityGroup cmdlet creates new instances of the Microsoft.Rtc.Man [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/New-CsCommonAreaPhone.md b/skype/skype-ps/skype/New-CsCommonAreaPhone.md index f2b574768d..948f235f55 100644 --- a/skype/skype-ps/skype/New-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/New-CsCommonAreaPhone.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skype/new-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -317,6 +317,3 @@ The New-CsCommonAreaPhone cmdlet creates new instances of the Microsoft.Rtc.Mana [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - - - diff --git a/skype/skype-ps/skype/New-CsConferenceDirectory.md b/skype/skype-ps/skype/New-CsConferenceDirectory.md index 7a4b7fc048..4a9c8747e0 100644 --- a/skype/skype-ps/skype/New-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/New-CsConferenceDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -158,6 +158,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Ps [Move-CsConferenceDirectory](Move-CsConferenceDirectory.md) [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) - - - diff --git a/skype/skype-ps/skype/New-CsConferencingConfiguration.md b/skype/skype-ps/skype/New-CsConferencingConfiguration.md index 4984c7cb0b..dd911eb816 100644 --- a/skype/skype-ps/skype/New-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/New-CsConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -642,6 +642,3 @@ The New-CsConferencingConfiguration cmdlet creates new instances of the Microsof [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) - - - diff --git a/skype/skype-ps/skype/New-CsConferencingPolicy.md b/skype/skype-ps/skype/New-CsConferencingPolicy.md index 7c5af75239..08fab2b313 100644 --- a/skype/skype-ps/skype/New-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/New-CsConferencingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csconferencingpolicy -applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingpolicy +applicable: Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, schema: 2.0.0 manager: bulenteg author: tomkau @@ -1106,6 +1106,3 @@ The New-CsConferencingPolicy cmdlet creates a new instance of the Microsoft.Rtc. [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) - - - diff --git a/skype/skype-ps/skype/New-CsCpsConfiguration.md b/skype/skype-ps/skype/New-CsCpsConfiguration.md index a1a5b9bf03..dfaf405eee 100644 --- a/skype/skype-ps/skype/New-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/New-CsCpsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 schema: 2.0.0 manager: rogupta @@ -273,5 +273,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Se [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - - diff --git a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md index c00d5d84d6..e0f256355d 100644 --- a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDeviceUpdateConfiguration schema: 2.0.0 diff --git a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md index f4b3b34508..db23830811 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDiagnosticConfiguration schema: 2.0.0 diff --git a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md index 8c9593b067..7906c3c207 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDiagnosticHeaderConfiguration schema: 2.0.0 @@ -259,5 +259,3 @@ The New-CsDiagnosticHeaderConfiguration cmdlet creates new instances of the Micr [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md b/skype/skype-ps/skype/New-CsDiagnosticsFilter.md index a15e7f3e33..d2f329786f 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md +++ b/skype/skype-ps/skype/New-CsDiagnosticsFilter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdiagnosticsfilter +online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticsfilter applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDiagnosticsFilter schema: 2.0.0 diff --git a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md index 770f6e4cd2..96f6b14689 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDialInConferencingAccessNumber schema: 2.0.0 @@ -391,5 +391,3 @@ The New-CsDialInConferencingAccessNumber cmdlet creates new instances of the Mic [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - - diff --git a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md index f6006eb803..d05fb34422 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDialInConferencingConfiguration schema: 2.0.0 @@ -280,5 +280,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Di [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md index 4179710641..80d7835196 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDialInConferencingDtmfConfiguration schema: 2.0.0 @@ -376,5 +376,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Di [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsDialPlan.md b/skype/skype-ps/skype/New-CsDialPlan.md index 132bfaca65..aff1a6f077 100644 --- a/skype/skype-ps/skype/New-CsDialPlan.md +++ b/skype/skype-ps/skype/New-CsDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csdialplan +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsDialPlan schema: 2.0.0 @@ -395,4 +395,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/New-CsEmergencyNumber.md b/skype/skype-ps/skype/New-CsEmergencyNumber.md index 37fd688295..f871386781 100644 --- a/skype/skype-ps/skype/New-CsEmergencyNumber.md +++ b/skype/skype-ps/skype/New-CsEmergencyNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csemergencynumber +online version: https://learn.microsoft.com/powershell/module/skype/new-csemergencynumber applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsEmergencyNumber schema: 2.0.0 @@ -98,6 +98,6 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[New-CsLocationPolicy](https://docs.microsoft.com/powershell/module/skype/new-cslocationpolicy?view=skype-ps) +[New-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy?view=skype-ps) -[Set-CsLocationPolicy](https://docs.microsoft.com/powershell/module/skype/set-cslocationpolicy?view=skype-ps) +[Set-CsLocationPolicy](https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsExUmContact.md b/skype/skype-ps/skype/New-CsExUmContact.md index b4483ba104..a9107cd958 100644 --- a/skype/skype-ps/skype/New-CsExUmContact.md +++ b/skype/skype-ps/skype/New-CsExUmContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skype/new-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsExUmContact schema: 2.0.0 @@ -264,5 +264,3 @@ Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmCon [Move-CsExUmContact](Move-CsExUmContact.md) [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsExtendedTest.md b/skype/skype-ps/skype/New-CsExtendedTest.md index 8701335fab..0b33391159 100644 --- a/skype/skype-ps/skype/New-CsExtendedTest.md +++ b/skype/skype-ps/skype/New-CsExtendedTest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csextendedtest +online version: https://learn.microsoft.com/powershell/module/skype/new-csextendedtest applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsExtendedTest schema: 2.0.0 @@ -140,5 +140,3 @@ The New-CsExtendedTest cmdlet creates new instances of the Microsoft.Rtc.Managem [New-CsWatcherNodeConfiguration](New-CsWatcherNodeConfiguration.md) [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md b/skype/skype-ps/skype/New-CsExternalAccessPolicy.md index 94d6bb2242..0e86942e9c 100644 --- a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/New-CsExternalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csexternalaccesspolicy -applicable: Microsoft Teams, Skype for Business Online, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalaccesspolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsExternalAccessPolicy schema: 2.0.0 author: tomkau @@ -12,6 +12,8 @@ ms.reviewer: rogupta # New-CsExternalAccessPolicy ## SYNOPSIS +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter EnablePublicCloudAccess can no longer be used. Enables you to create a new external access policy. @@ -25,8 +27,7 @@ For information about external access in Microsoft Teams, see [Manage external a ```powershell New-CsExternalAccessPolicy [-Tenant ] [-Description ] [-EnableFederationAccess ] [-EnableAcsFederationAccess ] - [-EnableXmppAccess ] [-EnablePublicCloudAccess ] - [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [-Identity] + [-EnableXmppAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -40,23 +41,18 @@ That might be sufficient to meet your communication needs. If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. -(Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). -3. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. -4. -Communicate with people who have SIP accounts with a public instant messaging service such as Skype. +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -5. -(Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/teams/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. When you install Skype for Business Server, a global external access policy is automatically created for you. In addition to the global policy, you can also create custom external access policies at either the site or the per-user scope. @@ -70,10 +66,8 @@ In addition, you can have only one external access policy per site: if the Redmo The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, InMemory, PipelineVariable, and Tenant - ## EXAMPLES - ### -------------------------- EXAMPLE 1 -------------------------- ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True @@ -94,6 +88,7 @@ In this example, the Global policy is updated to allow Teams-ACS federation for ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False ``` + The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. @@ -103,8 +98,6 @@ $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory $x.EnableFederationAccess = $True -$x.EnablePublicCloudAccess = $True - $x.EnableOutsideAccess = $True Set-CsExternalAccessPolicy -Instance $x @@ -114,7 +107,7 @@ Example 4 demonstrates the use of the InMemory parameter; this parameter enables After it has been created, you can modify the in-memory-only instance, then use the Set-CsExternalAccessPolicy cmdlet to transform the virtual policy into a real external access policy. To do this, the first command in the example uses the New-CsExternalAccessPolicy cmdlet and the InMemory parameter to create a virtual policy with the Identity RedmondAccessPolicy; this virtual policy is stored in a variable named $x. -The next three commands are used to modify three properties of the virtual policy: EnableFederationAccess, EnablePublicCloudAccess, and the EnableOutsideAccess. +The next three commands are used to modify two properties of the virtual policy: EnableFederationAccess and the EnableOutsideAccess. Finally, the last command uses the Set-CsExternalAccessPolicy cmdlet to create an actual per-user external access policy with the Identity RedmondAccessPolicy. If you do not call the Set-CsExternalAccessPolicy cmdlet, then the virtual policy will disappear as soon as you end your Windows PowerShell session or delete the variable $x. Should that happen, an external access policy with the Identity RedmondAccessPolicy will never be created. @@ -135,7 +128,7 @@ If you need to make changes to an existing policy, use the Set-CsExternalAccessP ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -152,7 +145,7 @@ For example, the Description might include information about the users the polic ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -170,7 +163,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -180,7 +173,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -EnableTeamsConsumerAccess (Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. @@ -189,11 +181,10 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -203,18 +194,17 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerInbound -(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who are using Teams with an account that's not managed by an organization can start the communication with the user. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -224,7 +214,7 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess -Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. +Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. @@ -233,7 +223,7 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False Position: Named @@ -249,7 +239,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -259,24 +249,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePublicCloudAccess -Indicates whether the user is allowed to communicate with people who have SIP accounts with a public Internet connectivity provider such as MSN. -Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -EnablePublicCloudAudioVideoAccess Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. When set to False, audio and video options in Skype for Business Server will be disabled any time a user is communicating with a public Internet connectivity contact. @@ -284,7 +256,7 @@ When set to False, audio and video options in Skype for Business Server will be ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -300,7 +272,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -317,7 +289,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -366,7 +338,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -389,7 +361,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -426,5 +398,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Exte [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md index f307d20efe..728455d346 100644 --- a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy applicable: Skype for Business Online title: New-CsExternalUserCommunicationPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsExternalUserCommunicationPolicy @@ -35,7 +35,7 @@ This cmdlet allows you to block P2P file transfer with Federated partners only. PS C:\> New-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` -This example creates a new policy to block external file transfer. Then you can use `Grant-CsExternalUserCommunicationPolicy` to assign it to an user account. +This example creates a new policy to block external file transfer. Then you can use `Grant-CsExternalUserCommunicationPolicy` to assign it to a user account. ## PARAMETERS @@ -215,10 +215,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Set-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) +[Set-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps) -[Get-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy?view=skype-ps) +[Get-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy?view=skype-ps) -[Remove-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) +[Remove-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps) -[Grant-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) +[Grant-CsExternalUserCommunicationPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsFIPSConfiguration.md b/skype/skype-ps/skype/New-CsFIPSConfiguration.md index 87cc75b7e6..64a8204ef3 100644 --- a/skype/skype-ps/skype/New-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/New-CsFIPSConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsFIPSConfiguration schema: 2.0.0 @@ -224,5 +224,3 @@ The New-CsFIPSConfiguration cmdlet creates new instances of the Microsoft.Rtc.Ma [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md index dbcfddc805..166f9d2ba7 100644 --- a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsFileTransferFilterConfiguration schema: 2.0.0 @@ -280,5 +280,3 @@ The New-CsFileTransferFilterConfiguration cmdlet creates new instances of the Mi [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md index 1317b271ca..2b89c659fb 100644 --- a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skype/new-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsGroupPickupUserOrbit schema: 2.0.0 @@ -52,7 +52,7 @@ The first parameter after the cmdlet is assumed to be the User parameter value. ### -Orbit Specifies the group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see [New-CsCallParkOrbit](https://docs.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). @@ -154,5 +154,3 @@ This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.Gr ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md index 818b5b7684..836ccad607 100644 --- a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsHealthMonitoringConfiguration schema: 2.0.0 @@ -311,5 +311,3 @@ The New-CsHealthMonitoringConfiguration cmdlet creates new instances of the Micr [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md index 5f00c818cf..31d525c270 100644 --- a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsHostedVoicemailPolicy schema: 2.0.0 @@ -39,7 +39,7 @@ Policies created at the site scope will be automatically assigned to the users h Policies created at the per-user scope must be assigned to users or contact objects with the Grant-CsHostedVoicemailPolicy cmdlet. > [!NOTE] -> Cloud Voicemail takes the place of Exchange Unified Messaging (UM) in providing voice messaging functionality for Skype for Business 2019 voice users who have mailboxes on Exchange Server 2019 or Exchange Online, and for Skype for Business Online voice users. For more information please check [Plan Cloud Voicemail service](https://docs.microsoft.com/skypeforbusiness/hybrid/plan-cloud-voicemail) and [Retiring Unified Messaging in Exchange Online](https://techcommunity.microsoft.com/t5/Exchange-Team-Blog/Retiring-Unified-Messaging-in-Exchange-Online/ba-p/608991). +> Cloud Voicemail takes the place of Exchange Unified Messaging (UM) in providing voice messaging functionality for Skype for Business 2019 voice users who have mailboxes on Exchange Server 2019 or Exchange Online, and for Skype for Business Online voice users. For more information please check [Plan Cloud Voicemail service](https://learn.microsoft.com/skypeforbusiness/hybrid/plan-cloud-voicemail) and [Retiring Unified Messaging in Exchange Online](https://techcommunity.microsoft.com/t5/Exchange-Team-Blog/Retiring-Unified-Messaging-in-Exchange-Online/ba-p/608991). ## EXAMPLES @@ -269,5 +269,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsHostingProvider.md b/skype/skype-ps/skype/New-CsHostingProvider.md index b82b285dfd..ef1f878ccf 100644 --- a/skype/skype-ps/skype/New-CsHostingProvider.md +++ b/skype/skype-ps/skype/New-CsHostingProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skype/new-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsHostingProvider schema: 2.0.0 @@ -373,5 +373,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Ed [Remove-CsHostingProvider](Remove-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - - diff --git a/skype/skype-ps/skype/New-CsHuntGroup.md b/skype/skype-ps/skype/New-CsHuntGroup.md deleted file mode 100644 index ee2a6caa7b..0000000000 --- a/skype/skype-ps/skype/New-CsHuntGroup.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cshuntgroup -applicable: Skype for Business Online -title: New-CsHuntGroup -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsHuntGroup - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsCallQueue](New-CsCallQueue.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md index e2720d0cd5..55b09cfd15 100644 --- a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsHybridApplicationEndpoint schema: 2.0.0 @@ -111,7 +111,7 @@ Accept wildcard characters: False ``` ### -OU -Active Directory Organizational Unit (OU) for the disabled user to be created. Wait for the newly created user object to be directory synced to the Azure Active Directory or start a new directory sync cycle by running the [Start-ADSyncSyncCycle](https://docs.microsoft.com/azure/active-directory/connect/active-directory-aadconnectsync-feature-scheduler#start-the-scheduler) on the domain controller machine. +Active Directory Organizational Unit (OU) for the disabled user to be created. Wait for the newly created user object to be directory synced to the Microsoft Entra ID or start a new directory sync cycle by running the [Start-ADSyncSyncCycle](https://learn.microsoft.com/azure/active-directory/connect/active-directory-aadconnectsync-feature-scheduler#start-the-scheduler) on the domain controller machine. ```yaml Type: OUIdParameter @@ -190,8 +190,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) -[Remove-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) +[Remove-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsHybridPSTNSite.md b/skype/skype-ps/skype/New-CsHybridPSTNSite.md index 062c4df5c7..7bd818bd11 100644 --- a/skype/skype-ps/skype/New-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/New-CsHybridPSTNSite.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridpstnsite applicable: Skype for Business Online title: New-CsHybridPSTNSite schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsHybridPSTNSite @@ -237,4 +237,3 @@ The New-CsHybridPSTNSite cmdlet returns instances of the HybridPstnSite object. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsImConfiguration.md b/skype/skype-ps/skype/New-CsImConfiguration.md index 435a3dec13..bff157c1c2 100644 --- a/skype/skype-ps/skype/New-CsImConfiguration.md +++ b/skype/skype-ps/skype/New-CsImConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsImConfiguration schema: 2.0.0 @@ -163,8 +163,8 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) -[Remove-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) +[Remove-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsImFilterConfiguration.md b/skype/skype-ps/skype/New-CsImFilterConfiguration.md index 8cc901ea1f..07c90a6de3 100644 --- a/skype/skype-ps/skype/New-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/New-CsImFilterConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csimfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsImFilterConfiguration schema: 2.0.0 @@ -327,4 +327,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFil [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md b/skype/skype-ps/skype/New-CsImTranslationConfiguration.md index d0a0c719f1..02129499f3 100644 --- a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/New-CsImTranslationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsImTranslationConfiguration schema: 2.0.0 @@ -225,5 +225,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsIssuedCertId.md b/skype/skype-ps/skype/New-CsIssuedCertId.md index 4f1ea9fca4..0303d409ac 100644 --- a/skype/skype-ps/skype/New-CsIssuedCertId.md +++ b/skype/skype-ps/skype/New-CsIssuedCertId.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csissuedcertid +online version: https://learn.microsoft.com/powershell/module/skype/new-csissuedcertid applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsIssuedCertId schema: 2.0.0 @@ -134,5 +134,3 @@ New-CsIssuedCertId creates instances of the Microsoft.Rtc.Management.WritableCon ## RELATED LINKS [New-CsSipProxyTLS](New-CsSipProxyTLS.md) - - diff --git a/skype/skype-ps/skype/New-CsKerberosAccount.md b/skype/skype-ps/skype/New-CsKerberosAccount.md index b5bf4b3018..85ed0abd14 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccount.md +++ b/skype/skype-ps/skype/New-CsKerberosAccount.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cskerberosaccount +online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccount applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsKerberosAccount schema: 2.0.0 @@ -191,5 +191,3 @@ The New-CsKerberosAccount cmdlet creates new instances of the Microsoft.Rtc.Mana ## RELATED LINKS [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) - - diff --git a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md index 99b0f02aeb..d02844a752 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsKerberosAccountAssignment schema: 2.0.0 @@ -193,4 +193,3 @@ The New-CsKerberosAccountAssignment cmdlet creates new instances of the Microsof [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/New-CsLocationPolicy.md b/skype/skype-ps/skype/New-CsLocationPolicy.md index 27309cbf95..bea3233f4e 100644 --- a/skype/skype-ps/skype/New-CsLocationPolicy.md +++ b/skype/skype-ps/skype/New-CsLocationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsLocationPolicy schema: 2.0.0 @@ -504,5 +504,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Locatio [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - - diff --git a/skype/skype-ps/skype/New-CsMcxConfiguration.md b/skype/skype-ps/skype/New-CsMcxConfiguration.md index afa73fe140..58a5312e5f 100644 --- a/skype/skype-ps/skype/New-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/New-CsMcxConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csmcxconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsMcxConfiguration schema: 2.0.0 manager: rogupta @@ -287,5 +287,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.M ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/New-CsMediaConfiguration.md b/skype/skype-ps/skype/New-CsMediaConfiguration.md index 188e7380d0..b90eef34a2 100644 --- a/skype/skype-ps/skype/New-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/New-CsMediaConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsMediaConfiguration schema: 2.0.0 @@ -346,7 +346,7 @@ Accept wildcard characters: False ``` ### -EnableVideoBasedSharing -Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://docs.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml Type: Boolean @@ -383,5 +383,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsMeetingConfiguration.md b/skype/skype-ps/skype/New-CsMeetingConfiguration.md index 0064e7784c..77faa8bbc2 100644 --- a/skype/skype-ps/skype/New-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/New-CsMeetingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsMeetingConfiguration schema: 2.0.0 @@ -414,5 +414,3 @@ The New-CsMeetingConfiguration cmdlet creates new instances of the Microsoft.Rtc [Remove-CsMeetingConfiguration](Remove-CsMeetingConfiguration.md) [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsMobilityPolicy.md b/skype/skype-ps/skype/New-CsMobilityPolicy.md index 4ea3022166..5e9016c50f 100644 --- a/skype/skype-ps/skype/New-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/New-CsMobilityPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csmobilitypolicy -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsMobilityPolicy schema: 2.0.0 manager: bulenteg @@ -324,7 +324,7 @@ Accept wildcard characters: False When set to True (the default value) users will be allowed to sync device contacts on the mobile apps. -More information: [How to disable CallKit integration for Skype for Business iOS](https://docs.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). +More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). ```yaml Type: Boolean @@ -551,4 +551,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mob ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md b/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md index e2a0fec3c8..cb3e77828a 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md +++ b/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkbwalternatepath +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwalternatepath applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkBWAlternatePath schema: 2.0.0 @@ -118,4 +118,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [New-CsNetworkRegion](New-CsNetworkRegion.md) [Set-CsNetworkRegion](Set-CsNetworkRegion.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md b/skype/skype-ps/skype/New-CsNetworkBWPolicy.md index 3f9d1343d5..f6cd2973a3 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md +++ b/skype/skype-ps/skype/New-CsNetworkBWPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkbwpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkBWPolicy schema: 2.0.0 @@ -137,4 +137,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [New-CsNetworkBandwidthPolicyProfile](New-CsNetworkBandwidthPolicyProfile.md) [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md index e003c360c0..0c27af1dff 100644 --- a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkBandwidthPolicyProfile schema: 2.0.0 @@ -296,4 +296,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) [New-CsNetworkBWPolicy](New-CsNetworkBWPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md index 4b63f69ed4..5a44fa962c 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkInterRegionRoute schema: 2.0.0 @@ -260,5 +260,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md index 15825e839b..445ced2da8 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkInterSitePolicy schema: 2.0.0 @@ -233,5 +233,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md b/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md index 2ce4b46cb6..37c19d474c 100644 --- a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md +++ b/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkmediabypassconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkmediabypassconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkMediaBypassConfiguration schema: 2.0.0 manager: bulenteg @@ -17,9 +17,6 @@ ms.reviewer: rogupta Creates new global settings for media bypass. This cmdlet was introduced in Lync Server 2010. - - - ## SYNTAX ``` @@ -40,8 +37,6 @@ The object created by this cmdlet must be saved to a variable and then assigned The settings created with this cmdlet can be retrieved only by accessing the MediaBypassSettings property of the global network configuration. To retrieve these settings, run this command: (Get-CsNetworkConfiguration).MediaBypassSettings. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -86,7 +81,6 @@ We assign those settings to the variable $a. In line 2 we modify the settings stored in variable $a by assigning the value False ($false) to the AlwaysBypass property. Finally, in line 3 we call the Set-CsNetworkConfiguration cmdlet, passing the MediaBypassSettings parameter the variable $a, which saves the change we made to the AlwaysBypass property. - ## PARAMETERS ### -AlwaysBypass @@ -108,8 +102,6 @@ Setting AlwaysBypass and Enabled both to True will auto-generate a bypass ID tha Default: False - - ```yaml Type: Boolean Parameter Sets: (All) @@ -133,8 +125,6 @@ This ID must be in the format of a GUID (for example, 96f14dea-5170-429a-b92b-f1 However, you will typically not have to set or change this parameter. This value is automatically generated when Enabled is set to True and either: 1) AlwaysBypass is set to True, or 2) the EnableDefaultBypassID parameter is set to True. - - ```yaml Type: String Parameter Sets: (All) @@ -158,7 +148,6 @@ At that point bypass decisions will be based on the value of the AlwaysBypass se Default: False - ```yaml Type: Boolean Parameter Sets: (All) @@ -185,8 +174,6 @@ Any subnets associated with the core need not be defined and bypass will automat Default: False - - ```yaml Type: Boolean Parameter Sets: (All) @@ -207,8 +194,6 @@ External media bypass is not supported in Skype for Business Server. Default: Off - - ```yaml Type: BypassModeEnumType Parameter Sets: (All) @@ -230,9 +215,6 @@ Other values for this parameter are reserved for future use. Default: Off - - - ```yaml Type: BypassModeEnumType Parameter Sets: (All) @@ -251,9 +233,6 @@ Accept wildcard characters: False Indicates whether media bypass should be used for audio/video conferences. The default value is False ($False). - - - ```yaml Type: Boolean Parameter Sets: (All) @@ -305,4 +284,3 @@ Creates an object reference of type Microsoft.Rtc.Management.WritableConfig.Sett [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) [Set-CsNetworkConfiguration](Set-CsNetworkConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsNetworkRegion.md b/skype/skype-ps/skype/New-CsNetworkRegion.md index a5ddf68eb1..eee2fe72cc 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegion.md +++ b/skype/skype-ps/skype/New-CsNetworkRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkRegion schema: 2.0.0 @@ -358,5 +358,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Get-CsNetworkRegion](Get-CsNetworkRegion.md) [New-CsNetworkBWAlternatePath](New-CsNetworkBWAlternatePath.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkRegionLink.md b/skype/skype-ps/skype/New-CsNetworkRegionLink.md index c755d97873..20c21b9c30 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/New-CsNetworkRegionLink.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkRegionLink schema: 2.0.0 @@ -240,5 +240,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Se [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) [New-CsNetworkSite](New-CsNetworkSite.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkSite.md b/skype/skype-ps/skype/New-CsNetworkSite.md index 578ac84eb2..160f838625 100644 --- a/skype/skype-ps/skype/New-CsNetworkSite.md +++ b/skype/skype-ps/skype/New-CsNetworkSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkSite schema: 2.0.0 @@ -356,5 +356,3 @@ Create an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Networ [Get-CsLocationPolicy](Get-CsLocationPolicy.md) [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsNetworkSubnet.md b/skype/skype-ps/skype/New-CsNetworkSubnet.md index 87a1e35e6f..38d0bfaf72 100644 --- a/skype/skype-ps/skype/New-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/New-CsNetworkSubnet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsNetworkSubnet schema: 2.0.0 @@ -275,4 +275,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Netwo [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) [Get-CsNetworkSite](Get-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/New-CsOAuthServer.md b/skype/skype-ps/skype/New-CsOAuthServer.md index fd9f42fc4d..683832a330 100644 --- a/skype/skype-ps/skype/New-CsOAuthServer.md +++ b/skype/skype-ps/skype/New-CsOAuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skype/new-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsOAuthServer schema: 2.0.0 @@ -51,7 +51,7 @@ New-CsOAuthServer -Identity "Office 365" -MetadataUrl "https://sts.office365.mic ``` Example 1 creates a new OAuth Server named "Office 365". -The new server uses the metadata URL https://sts.office365.microsoft.com/metadata/json/1. +The new server uses the metadata URL `https://sts.office365.microsoft.com/metadata/json/1`. ## PARAMETERS @@ -277,5 +277,3 @@ The New-CsOAuthServer cmdlet creates new instances of the Microsoft.Rtc.Manageme [Remove-CsOAuthServer](Remove-CsOAuthServer.md) [Set-CsOAuthServer](Set-CsOAuthServer.md) - - diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md deleted file mode 100644 index e0882330f7..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint -applicable: Skype for Business Online -title: New-CsOnlineApplicationEndpoint -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOnlineApplicationEndpoint - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. This cmdlet will be removed in the near future. -> -> Please use the [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) cmdlet instead. - -The `New-CsOnlineApplicationEndpoint` creates a Trusted Application Endpoint for a tenant. - -## SYNTAX -``` -New-CsOnlineApplicationEndpoint -ApplicationId [-CallbackUri ] -Name [-Region ] - [-Uri] [-Audience ] [-Ring ] [-PhoneNumber ] [-IsInternalRun ] - [-Tenant ] [-RunFullProvisioningFlow ] [-DomainController ] [-Force] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet creates a Trusted Application Endpoint. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -New-CsOnlineApplicationEndpoint -Uri "sip:sample@domain.com" -ApplicationId "44ff763b-5d1f-40ab-95bf-f31kc8757998" -Name "SampleApp" -PhoneNumber "19841110909" -``` - -This example creates a new application endpoint. - -## PARAMETERS - -### -ApplicationId -The Azure ApplicationID/ClientID from the Azure portal registration steps. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -A friendly name of your application within Skype for Business Online. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Sip Uri that identifies the tenant specific endpoint for the application. This must be a unique URI that does not conflict with an existing user in the tenant. Requests sent to this endpoint will trigger the Trusted Application API sending an event to the application, indicating that someone has sent a request. For example: helpdesk@contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallbackUri -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The service number assigned to the trusted application endpoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Region -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -[Get-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint) - -[Set-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/set-csonlineapplicationendpoint) - -[Remove-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://docs.microsoft.com/skype-sdk/trusted-application-api/docs/trustedapplicationendpoint) - diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md deleted file mode 100644 index 705da10f7d..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationinstance -applicable: Skype for Business Online -title: New-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOnlineApplicationInstance - -## SYNOPSIS -Creates an application instance in Azure Active Directory. - -## SYNTAX - -``` -New-CsOnlineApplicationInstance [-UserPrincipalName] [[-ApplicationId] ] [[-DisplayName] ] - [-Tenant ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet is used to create an application instance in Azure Active Directory. This same cmdlet is also run when creating a new resource account using Teams Admin Center. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -```powershell -New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" -``` - -This example creates a new application instance for an Auto Attendant with UserPrincipalName "appinstance01@contoso.com", ApplicationId "ce933385-9390-45d1-9512-c8d228074e07", DisplayName "AppInstance01" for the tenant. - -The application ID's that you need to use while creating the application instances are: - -Auto Attendant: ce933385-9390-45d1-9512-c8d228074e07 -Call Queue: 11cd3e2e-fccb-42ad-ad00-878b93575e07 - -## PARAMETERS - -### -UserPrincipalName -The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -The application ID. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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/skype/skype-ps/skype/New-CsOnlineAudioFile.md b/skype/skype-ps/skype/New-CsOnlineAudioFile.md deleted file mode 100644 index 69091b4719..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineAudioFile.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlineaudiofile -applicable: Skype for Business Online -title: New-CsOnlineAudioFile -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOnlineAudioFile - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. Use the [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) cmdlet instead. - diff --git a/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md b/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md deleted file mode 100644 index b0ac8680bd..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinebulkassignmentinput -applicable: Skype for Business Online -title: New-CsOnlineBulkAssignmentInput -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOnlineBulkAssignmentInput - -## SYNOPSIS -Provide the topic introduction here. - -**Note**: This cmdlet will be deprecated. - -## SYNTAX - -``` -New-CsOnlineBulkAssignmentInput [-Identity] [-TelephoneNumber ] - [-LocationID ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - - -## PARAMETERS - -### -Identity -PARAMVALUE: UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationID -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md deleted file mode 100644 index c54f255041..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,747 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinenumberportinorder -applicable: Skype for Business Online -title: New-CsOnlineNumberPortInOrder -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -New-CsOnlineNumberPortInOrder [-Tenant ] -InventoryType [-TelephoneNumbers ] - [-LOABase64PayLoad ] [-LOAContentType ] [-LOAAuthorizingPerson ] - [-SubscriberArea ] [-SubscriberCity ] [-SubscriberCountry ] - [-SubscriberStreetName ] [-SubscriberBuildingNumber ] [-SubscriberZipCode ] - [-SubscriberBusinessName ] [-BillingTelephoneNumber ] [-SubscriberFirstName ] - [-SubscriberLastName ] [-EmailAddresses ] [-RequestedFocDate ] - [-LosingTelcoPin ] [-LosingTelcoAccountId ] [-IsPartialPort] - [-SubscriberAddressLine1 ] [-SubscriberAddressLine2 ] [-SubscriberAddressLine3 ] - [-FriendlyName ] [-IsManual] [-RequestedFocDateBegin ] - [-RequestedFocDateEnd ] [-RangeHolder ] [-TelephoneNumberRanges ] - [-SubscriberAdditionalInfo ] [-SubscriberBuildingNumberSuffix ] - [-SubscriberStreetSuffix ] [-SubscriberPreDirectional ] [-SubscriberPostDirectional ] - [-SubscriberDescription ] [-SubscriberCounty ] [-SubscriberCompanyName ] - [-SubscriberCityAlias ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - -## PARAMETERS - -### -InventoryType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BillingTelephoneNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsManual -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPartialPort -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAAuthorizingPerson -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOABase64PayLoad -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAContentType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoAccountId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoPin -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RangeHolder -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDateBegin -PARAMVALUE: DateTimeOffset - -```yaml -Type: DateTimeOffset -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDateEnd -PARAMVALUE: DateTimeOffset - -```yaml -Type: DateTimeOffset -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAdditionalInfo -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine1 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine2 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine3 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberArea -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBuildingNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBuildingNumberSuffix -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBusinessName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCityAlias -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCompanyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCountry -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCounty -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberDescription -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberFirstName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberLastName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberPostDirectional -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberPreDirectional -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberStreetName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberStreetSuffix -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberZipCode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberRanges -PARAMVALUE: String\[\]\[\] - -```yaml -Type: String[][] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumbers -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/New-CsOnlineSession.md b/skype/skype-ps/skype/New-CsOnlineSession.md deleted file mode 100644 index 91f93942c0..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineSession.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: SkypeOnlineConnectorStartup-help.xml -applicable: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinesession -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOnlineSession - -## SYNOPSIS - > [!Note] - > Skype for Business Online Connector is currently part of the latest Teams PowerShell module. If you're using the latest Teams PowerShell public release, you don't need to install the Skype for Business Online Connector. - > With Teams PowerShell Module New-CsOnlineSession has been deprecated and is no longer required to connect Skype for Business Online. It has been replaced with Connect-MicrosoftTeams. - - -Creates a persistent connection to Microsoft Skype for Business Online DataCenter. - -## SYNTAX - -### Credential (Default) -``` -New-CsOnlineSession [[-Credential] ] [-OverrideAdminDomain ] [-OverridePowerShellUri ] [-TeamsEnvironmentName ] [-SessionOption ] [] -``` - -## DESCRIPTION -Enables you to create a remote Windows PowerShell session that connects to Skype for Business Online. -In this session, Skype for Business Online administrator can run Skype for Business cmdlets to manage users, policies and configurations. - -## EXAMPLES - -### EXAMPLE 1 -``` -$credential = get-credential -New-CsOnlineSession -Credential $credential -``` - -Establishes a Skype for Business Online Remote PowerShell session, supplying the credentials of a Skype for Business Online administrator account. - -### EXAMPLE 2 -``` -$credential = get-credential -New-CsOnlineSession -Credential $credential -OverrideAdminDomain fabrikam.onmicrosoft.com -``` - -Establishes a Skype for Business Online Remote PowerShell session, with a Skype for Business Online administrator account that has permission to manage the tenant fabrikam.onmicrosoft.com that was specified using the optional OverrideAdminDomain parameter. - -### EXAMPLE 3 -``` -$sfbSession = New-CsOnlineSession -Import-PSSession $sfbSession -``` - -Establishes a Skype for Business Online Remote PowerShell session using multi-factor authentication, for more information, see [Connect using a Skype for Business Online administrator account with multi-factor authentication](https://docs.microsoft.com/office365/enterprise/powershell/manage-skype-for-business-online-with-office-365-powershell#connect-using-a-skype-for-business-online-administrator-account-with-multi-factor-authentication). - -## PARAMETERS - -### -Credential -Specifies a Skype for Business Online administrator, or Syndicated Partner administrator account. -Enter a PSCredential object, such as one returned by the Get-Credential cmdlet. - - -```yaml -Type: PSCredential -Parameter Sets: Credential -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideAdminDomain -Specifies the domain of the tenant to be managed. This is used when the administrator has permissions to manage more than one tenant. For example, Syndicated Partner administrators commonly manage several tenants. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverridePowerShellUri -Specifies Skype for Business Remote Powershell URI. -Optional. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsEnvironmentName -Use this setting if your organization is in one of the Teams Government Cloud environments. - -Specify "TeamsGCCH" if your organization is in the GCC High Environment. Specify "TeamsDOD" if your organization is in the DoD Environment. - -```yaml -Type: String -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionOption -Sets advanced options for the session. -Enter a SessionOption object, such as one that you create by using the New-PSSessionOption cmdlet, or a hash table in which the keys are session option names and the values are session option values. - -```yaml -Type: PSSessionOption -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendant.md deleted file mode 100644 index fb4e558406..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendant -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendant -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendant - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendant](New-CsAutoAttendant.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallFlow.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallFlow.md deleted file mode 100644 index 8ea37894f0..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallFlow.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantcallflow -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantCallFlow -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantCallFlow - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md deleted file mode 100644 index 462875f096..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantcallhandlingassociation -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantCallHandlingAssociation -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantCallHandlingAssociation - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallableEntity.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallableEntity.md deleted file mode 100644 index 1a9f52264e..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantCallableEntity.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantcallableentity -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantCallableEntity -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantCallableEntity - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantDialScope.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantDialScope.md deleted file mode 100644 index 93c3823446..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantDialScope.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantdialscope -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantDialScope -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantDialScope - -## SYNOPSIS - -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenu.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenu.md deleted file mode 100644 index 0b38c36666..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenu.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantmenu -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantMenu -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantMenu - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenuOption.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenuOption.md deleted file mode 100644 index 4fe165276b..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantMenuOption.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantmenuoption -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantMenuOption -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantMenuOption - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantPrompt.md b/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantPrompt.md deleted file mode 100644 index 784e68ce82..0000000000 --- a/skype/skype-ps/skype/New-CsOrganizationalAutoAttendantPrompt.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csorganizationalautoattendantprompt -applicable: Skype for Business Online -title: New-CsOrganizationalAutoAttendantPrompt -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsOrganizationalAutoAttendantPrompt - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) cmdlet instead. diff --git a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md index 8d31f123e6..db567dff75 100644 --- a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsOutboundCallingNumberTranslationRule schema: 2.0.0 @@ -294,5 +294,3 @@ The New-CsOutboundCallingNumberTranslationRule cmdlet creates new instances of t [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) - - diff --git a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md b/skype/skype-ps/skype/New-CsOutboundTranslationRule.md index 08932e99fe..73e18b5b4f 100644 --- a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/New-CsOutboundTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsOutboundTranslationRule schema: 2.0.0 @@ -297,5 +297,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Se [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) - - diff --git a/skype/skype-ps/skype/New-CsPartnerApplication.md b/skype/skype-ps/skype/New-CsPartnerApplication.md index e280e910b5..60a75d1f84 100644 --- a/skype/skype-ps/skype/New-CsPartnerApplication.md +++ b/skype/skype-ps/skype/New-CsPartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skype/new-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPartnerApplication schema: 2.0.0 @@ -72,12 +72,12 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ### -------------------------- Example 1 -------------------------- ``` -New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationTrustLevel "Full" -MetadataUrl"https://autodiscover.litwareinc.com/metadata/json/1" +New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationTrustLevel "Full" -MetadataUrl "https://autodiscover.litwareinc.com/metadata/json/1" ``` The command shown in Example 1 creates a new partner application with the Identity "MicrosoftExchange". -In this example, the new partner application uses the metadata URL https://autodiscover.litwareinc.com/metadata/json/1. +In this example, the new partner application uses the metadata URL `https://autodiscover.litwareinc.com/metadata/json/1`. ### -------------------------- Example 2 -------------------------- @@ -163,9 +163,9 @@ Accept wildcard characters: False Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these: -`$x = Get-Content "C:\Certificates\PartnerApplication.cer" -Encoding Byte` +`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` -`$y = \[Convert\]::ToBase64String($x)` +`$y = [Convert]::ToBase64String($x)` You can then use this syntax to assign the certificate data stored in the variable $y: @@ -414,4 +414,3 @@ The New-CsPartnerApplication cmdlet creates new instances of the Microsoft.Rtc.M [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) [Set-CsPartnerApplication](Set-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/New-CsPersistentChatAddin.md b/skype/skype-ps/skype/New-CsPersistentChatAddin.md index 7fef7cd2e4..6b554367cb 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/New-CsPersistentChatAddin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchataddin +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatAddin schema: 2.0.0 manager: rogupta @@ -18,8 +18,6 @@ Enables you to configure a new Persistent Chat add-in. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -40,8 +38,6 @@ Instead, the CsPersistentChatAddin cmdlets are used to associate (or disassociat Skype for Business Server Control Panel: To create a new Persistent Chat add-in using the Skype for Business Server Control Panel, click Persistent Chat, click Add-in, and then click New. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -51,7 +47,7 @@ New-CsPersistentChatAddin -Name "ITPersistentChatAddin" -PersistentChatPoolFqdn ``` The command shown in Example 1 creates a new Persistent Chat add-in (with the name ITPersistentChatAddin) for the pool atl-cs-001.litwareinc.com. -The URL parameter and the parameter value https://atl-cs-001.litwareinc.com/itchat specify the location of the add-in's webpage. +The URL parameter and the parameter value `https://atl-cs-001.litwareinc.com/itchat` specify the location of the add-in's webpage. ## PARAMETERS @@ -61,8 +57,6 @@ The URL parameter and the parameter value https://atl-cs-001.litwareinc.com/itch Friendly name to be given to the Persistent Chat add-in. Names must be unique per Persistent Chat Server pool. - - ```yaml Type: String Parameter Sets: (All) @@ -80,8 +74,6 @@ Accept wildcard characters: False URL of the webpage to be displayed by the Persistent Chat add-in. - - ```yaml Type: String Parameter Sets: (All) @@ -99,8 +91,6 @@ Accept wildcard characters: False Fully qualified domain name of the Persistent Chat Server pool. - - ```yaml Type: String Parameter Sets: (All) @@ -138,5 +128,3 @@ The New-CsPersistentChatAddin cmdlet creates new instances of the Microsoft.Rtc. [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatCategory.md b/skype/skype-ps/skype/New-CsPersistentChatCategory.md index ddb8799d74..807ee1f92c 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/New-CsPersistentChatCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcategory +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatCategory schema: 2.0.0 manager: rogupta @@ -22,8 +22,6 @@ Instead, existing rooms must later be assigned to a category by using the Set-Cs However, new chat rooms can be assigned to the category at the same time the room is created. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -46,8 +44,6 @@ That means that you must create at least one category before you can add any cha Skype for Business Server Control Panel: To create a new Persistent Chat category using the Skype for Business Server Control Panel, click Persistent Chat, click Category, and then click New. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -185,4 +181,3 @@ The New-CsPersistentChatCategory cmdlet creates new instances of the Microsoft.R [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md index d988fecdf6..98ea85b68d 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcomplianceconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta @@ -18,8 +18,6 @@ Creates a new collection of Persistent Chat compliance configuration settings at Persistent Chat compliance enables administrators to maintain an archive of Persistent Chat items and activities including: new messages; new events (for example, a user entering or existing a chat room); file uploads and downloads; and searches run against the chat history. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -43,8 +41,6 @@ In addition, Persistent Chat compliance can only be managed using the Windows Po Skype for Business Server Control Panel: The functions carried out by the New-CsPersistentChatComplianceConfiguration cmdlet are not available in the Skype for Business Server Control Panel. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -134,8 +130,6 @@ This adapter is supplied by a third-party or can be set to the internal XML adap If you do not specify an adapter type Persistent Chat will not save compliance data. - - ```yaml Type: String Parameter Sets: (All) @@ -156,8 +150,6 @@ This has the potential to greatly increase the size of the compliance data. The default value is False. - - ```yaml Type: Boolean Parameter Sets: (All) @@ -178,8 +170,6 @@ This has the potential to greatly increase the size of the compliance data. The default value is False. - - ```yaml Type: Boolean Parameter Sets: (All) @@ -214,8 +204,6 @@ Accept wildcard characters: False When set to True, additional output files will be created to track file transfers within chat rooms. These files will have the file extension .ATTACH and are placed in the location specified by the AdapterOutputDirectory. - - ```yaml Type: Boolean Parameter Sets: (All) @@ -233,8 +221,6 @@ Accept wildcard characters: False XSLT transform script that enables Persistent Chat to save compliance data in a custom format of your design. - - ```yaml Type: String Parameter Sets: (All) @@ -360,5 +346,3 @@ The New-CsPersistentChatComplianceConfiguration cmdlet creates new instances of [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md index e65f625ed3..ede3df5de1 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta @@ -19,8 +19,6 @@ Persistent Chat configuration settings are used to manage the Persistent Chat se For example, these settings allow you to specify the maximum number of users who can participate in a chat room. This cmdlet was introduced in Lync Server 2013. - - ## SYNTAX ``` @@ -40,8 +38,6 @@ These settings can be configured at the global or the site scope, or at the serv Skype for Business Server Control Panel: To create a new collection of Persistent Chat configuration settings using the Skype for Business Server Control Panel, click Persistent Chat, click Persistent Chat Configuration, click New, and then click either Site configuration or Pool configuration. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -53,7 +49,6 @@ New-CsPersistentChatConfiguration -Identity "site:Redmond" -ParticipantUpdateLim The command shown in Example 1 creates a new set of Persistent Chat configuration settings applied to the Redmond site. In this example, the ParticipantUpdateLimit property is set to 100. - ## PARAMETERS ### -Identity @@ -238,5 +233,3 @@ The New-CsPersistentChatConfiguration cmdlet creates new instances of the Micros [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md index 8064bc314a..ea7227eca8 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchatendpoint -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatendpoint +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatEndpoint schema: 2.0.0 manager: rogupta @@ -181,4 +181,3 @@ The New-CsPersistentChatEndpoint cmdlet creates new instances of the Microsoft.R [Get-CsPersistentChatEndpoint](Get-CsPersistentChatEndpoint.md) [Remove-CsPersistentChatEndpoint](Remove-CsPersistentChatEndpoint.md) - diff --git a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md b/skype/skype-ps/skype/New-CsPersistentChatPolicy.md index 69d1f3b1e8..24a866881d 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/New-CsPersistentChatPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta @@ -245,5 +245,3 @@ The New-CsPersistentChatPolicy cmdlet creates new instances of the Microsoft.Rtc [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsPersistentChatRoom.md b/skype/skype-ps/skype/New-CsPersistentChatRoom.md index 4ed0fccfbd..b387851687 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/New-CsPersistentChatRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatRoom schema: 2.0.0 manager: rogupta @@ -251,5 +251,3 @@ The New-CsPersistentChatRoom cmdlet creates new instances of the Microsoft.Rtc.M [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) - - diff --git a/skype/skype-ps/skype/New-CsPinPolicy.md b/skype/skype-ps/skype/New-CsPinPolicy.md index 6972a69438..36afdd1b3c 100644 --- a/skype/skype-ps/skype/New-CsPinPolicy.md +++ b/skype/skype-ps/skype/New-CsPinPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPinPolicy schema: 2.0.0 @@ -388,5 +388,3 @@ Creates a new instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Use [Remove-CsPinPolicy](Remove-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md b/skype/skype-ps/skype/New-CsPlatformServiceSettings.md index 4bfb39a8e4..a469445901 100644 --- a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/New-CsPlatformServiceSettings.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPlatformServiceSettings schema: 2.0.0 manager: rogupta @@ -297,8 +297,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Set-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsPresencePolicy.md b/skype/skype-ps/skype/New-CsPresencePolicy.md index 879afba5d1..3fbe18e8f8 100644 --- a/skype/skype-ps/skype/New-CsPresencePolicy.md +++ b/skype/skype-ps/skype/New-CsPresencePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPresencePolicy schema: 2.0.0 @@ -293,5 +293,3 @@ The New-CsPresencePolicy cmdlet creates new instances of the Microsoft.Rtc.Manag [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - - diff --git a/skype/skype-ps/skype/New-CsPresenceProvider.md b/skype/skype-ps/skype/New-CsPresenceProvider.md index 5d5b0fb5c2..a7723a9ad6 100644 --- a/skype/skype-ps/skype/New-CsPresenceProvider.md +++ b/skype/skype-ps/skype/New-CsPresenceProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skype/new-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPresenceProvider schema: 2.0.0 @@ -242,4 +242,3 @@ The New-CsPresenceProvider cmdlet creates new instances of the Microsoft.Rtc.Man [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) [Set-CsPresenceProvider](Set-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md b/skype/skype-ps/skype/New-CsPrivacyConfiguration.md index 844c6fdad2..73c2badb7b 100644 --- a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/New-CsPrivacyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csprivacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPrivacyConfiguration schema: 2.0.0 @@ -312,5 +312,3 @@ The New-CsPrivacyConfiguration cmdlet creates new instances of the Microsoft.Rtc [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsProxyConfiguration.md b/skype/skype-ps/skype/New-CsProxyConfiguration.md index 7a54a3f66d..2d9e20f244 100644 --- a/skype/skype-ps/skype/New-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/New-CsProxyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsProxyConfiguration schema: 2.0.0 @@ -615,5 +615,3 @@ The New-CsProxyConfiguration cmdlet creates new instances of the Microsoft.Rtc.M [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsPublicProvider.md b/skype/skype-ps/skype/New-CsPublicProvider.md index e4c2f13dc1..3350062fcf 100644 --- a/skype/skype-ps/skype/New-CsPublicProvider.md +++ b/skype/skype-ps/skype/New-CsPublicProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skype/new-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPublicProvider schema: 2.0.0 @@ -377,5 +377,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Ed [Remove-CsPublicProvider](Remove-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - - diff --git a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md index a3583defaf..614ff79df4 100644 --- a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPushNotificationConfiguration schema: 2.0.0 manager: rogupta @@ -260,9 +260,8 @@ The New-CsPushNotificationConfiguration cmdlet creates new instances of the Micr ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) - -[Remove-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Remove-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/New-CsQoEConfiguration.md b/skype/skype-ps/skype/New-CsQoEConfiguration.md index d021a867a3..936e584b5d 100644 --- a/skype/skype-ps/skype/New-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/New-CsQoEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsQoEConfiguration schema: 2.0.0 @@ -322,5 +322,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.QoE.Q [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md b/skype/skype-ps/skype/New-CsRegistrarConfiguration.md index 043834e5bb..cb6eea8e9f 100644 --- a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/New-CsRegistrarConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRegistrarConfiguration schema: 2.0.0 @@ -432,5 +432,3 @@ The New-CsRegistrarConfiguration cmdlet creates new instances of the Microsoft.R [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsReportingConfiguration.md b/skype/skype-ps/skype/New-CsReportingConfiguration.md index 5b8cf483ce..5b76d057c5 100644 --- a/skype/skype-ps/skype/New-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/New-CsReportingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsReportingConfiguration schema: 2.0.0 @@ -58,7 +58,7 @@ New-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-001.l ``` The command shown in Example 1 creates a new collection of reporting configuration settings assigned to the monitoring database with the identity service:MonitoringDatabase:atl-sql-001.litwareinc.com. -In this example, the value of the ReportingUrl property is set to "https://atl-sql-001.litwareinc.com/lync_reports". +In this example, the value of the ReportingUrl property is set to `https://atl-sql-001.litwareinc.com/lync_reports`. ## PARAMETERS @@ -189,5 +189,3 @@ The New-CsReportingConfiguration cmdlet creates new instances of the Microsoft.R [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsAgentGroup.md b/skype/skype-ps/skype/New-CsRgsAgentGroup.md index 1dbf72e3ab..ce81c7775c 100644 --- a/skype/skype-ps/skype/New-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/New-CsRgsAgentGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsAgentGroup schema: 2.0.0 @@ -342,4 +342,3 @@ New-CsRgsAgentGroup creates new instances of the Microsoft.Rtc.Rgs.Management.Wr [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/New-CsRgsAnswer.md b/skype/skype-ps/skype/New-CsRgsAnswer.md index 6a7fac41d0..446e74549c 100644 --- a/skype/skype-ps/skype/New-CsRgsAnswer.md +++ b/skype/skype-ps/skype/New-CsRgsAnswer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsanswer +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsanswer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsAnswer schema: 2.0.0 @@ -172,5 +172,3 @@ Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Answe ## RELATED LINKS [New-CsRgsQuestion](New-CsRgsQuestion.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsCallAction.md b/skype/skype-ps/skype/New-CsRgsCallAction.md index 12940a18a0..5e38c17538 100644 --- a/skype/skype-ps/skype/New-CsRgsCallAction.md +++ b/skype/skype-ps/skype/New-CsRgsCallAction.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgscallaction +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgscallaction applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsCallAction schema: 2.0.0 @@ -229,4 +229,3 @@ New-CsRgsCallAction creates new instances of the Microsoft.Rtc.Rgs.Management.Wr [New-CsRgsQueue](New-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/New-CsRgsHoliday.md b/skype/skype-ps/skype/New-CsRgsHoliday.md index b1f4b898a0..18b0630657 100644 --- a/skype/skype-ps/skype/New-CsRgsHoliday.md +++ b/skype/skype-ps/skype/New-CsRgsHoliday.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsholiday +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholiday applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsHoliday schema: 2.0.0 @@ -164,4 +164,3 @@ New-CsRgsHoliday creates new instances of the Microsoft.Rtc.Rgs.Management.Writa [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/New-CsRgsHolidaySet.md b/skype/skype-ps/skype/New-CsRgsHolidaySet.md index 12f3d09699..d86a40c358 100644 --- a/skype/skype-ps/skype/New-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/New-CsRgsHolidaySet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsHolidaySet schema: 2.0.0 @@ -247,5 +247,3 @@ New-CsRgsHolidaySet creates new instances of the Microsoft.Rtc.Rgs.Management.Wr [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md index f598d11f95..137037c180 100644 --- a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsHoursOfBusiness schema: 2.0.0 @@ -563,4 +563,3 @@ Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Busin [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/New-CsRgsPrompt.md b/skype/skype-ps/skype/New-CsRgsPrompt.md index 08fcfdab62..663c604f09 100644 --- a/skype/skype-ps/skype/New-CsRgsPrompt.md +++ b/skype/skype-ps/skype/New-CsRgsPrompt.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsprompt +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsprompt applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsPrompt schema: 2.0.0 @@ -18,8 +18,6 @@ Creates a new workflow prompt for the Response Group application. A workflow prompt is either an audio file that is played or text that is read aloud in order to supply callers with additional information. This cmdlet was introduced in Lync Server 2010. - - ## SYNTAX ``` @@ -49,8 +47,6 @@ Each time you need to use a prompt it must be created from scratch; there is no If you provide both a text-to-speech and an audio file prompt, the Response Group application will use the audio file by default, and will rely on the text-to-speech prompt only if the audio file is unavailable. After new prompts are created in memory, the corresponding object reference is then typically added to a Response Group call action. - - ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- @@ -73,16 +69,14 @@ The final command in the example uses New-CsRgsCallAction to create a new Respon When creating the call action, the object reference $prompt (which contains the newly-created workflow prompt) is used as the value for the Prompt parameter; the object reference $queue is likewise used in conjunction with the QueueID parameter. After running this command, the new call action and its new workflow prompt are ready to be added to a Response Group workflow. - ### -------------------------- EXAMPLE 2 -------------------------- ``` $queue = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" -$audioFile = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "welcome.wav" -Content (Get-Content C:\Media\Welcome.wav -Encoding byte -ReadCount 0) +$audioFile = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "welcome.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\Welcome.wav')) -$prompt = New-CsRgsPrompt -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to the help desk. -Please hold." +$prompt = New-CsRgsPrompt -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to the help desk. Please hold." $z = New-CsRgsCallAction -Prompt $prompt -Action TransferToQueue -QueueID $queue.Identity ``` @@ -96,7 +90,6 @@ After the audio file has been imported, both it and a text-to-speech prompt are To do this, the AudioFilePrompt parameter is set to $audioFile, and the TextToSpeechPrompt parameter is set to the text value "Welcome to the help desk. Please hold." - ## PARAMETERS ### -TextToSpeechPrompt @@ -154,5 +147,3 @@ New-CsRgsPrompt creates instances of the Microsoft.Rtc.Management.WritableSettin [Import-CsRgsAudioFile](Import-CsRgsAudioFile.md) [New-CsRgsCallAction](New-CsRgsCallAction.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsQuestion.md b/skype/skype-ps/skype/New-CsRgsQuestion.md index 6cd1c717c6..9a30312ad9 100644 --- a/skype/skype-ps/skype/New-CsRgsQuestion.md +++ b/skype/skype-ps/skype/New-CsRgsQuestion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsquestion +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsquestion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsQuestion schema: 2.0.0 @@ -193,5 +193,3 @@ New-CsRgsQuestion creates instances of the Microsoft.Rtc.Management.WriteableSet ## RELATED LINKS [New-CsRgsAnswer](New-CsRgsAnswer.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsQueue.md b/skype/skype-ps/skype/New-CsRgsQueue.md index fc4efda298..119cd58947 100644 --- a/skype/skype-ps/skype/New-CsRgsQueue.md +++ b/skype/skype-ps/skype/New-CsRgsQueue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsQueue schema: 2.0.0 @@ -322,5 +322,3 @@ New-CsRgsQueue creates new instances of the Microsoft.Rtc.Rgs.Management.Writabl [Remove-CsRgsQueue](Remove-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - - diff --git a/skype/skype-ps/skype/New-CsRgsTimeRange.md b/skype/skype-ps/skype/New-CsRgsTimeRange.md index 39b58bb1c7..7d567a2ff5 100644 --- a/skype/skype-ps/skype/New-CsRgsTimeRange.md +++ b/skype/skype-ps/skype/New-CsRgsTimeRange.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgstimerange +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgstimerange applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsTimeRange schema: 2.0.0 @@ -175,4 +175,3 @@ New-CsRgsTimeRange creates new instances of the Microsoft.Rtc.Rgs.Management.Wri [New-CsRgsHoursOfBusiness](New-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/New-CsRgsWorkflow.md b/skype/skype-ps/skype/New-CsRgsWorkflow.md index 8f66464abf..dd48bcbd80 100644 --- a/skype/skype-ps/skype/New-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/New-CsRgsWorkflow.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRgsWorkflow schema: 2.0.0 @@ -322,7 +322,7 @@ However, that language can be used in a workflow only if it is a language suppor The language must be specified using one of the following language codes: -ca-ES - Catalan (Spain) +ca-ES - Catalan da-DK - Danish (Denmark) @@ -597,4 +597,3 @@ The New-CsRgsWorkflow cmdlet creates new instances of the Microsoft.Rtc.Rgs.Mana [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/New-CsRoutingConfiguration.md b/skype/skype-ps/skype/New-CsRoutingConfiguration.md index 7f27b048bb..b71bf8d54b 100644 --- a/skype/skype-ps/skype/New-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/New-CsRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsRoutingConfiguration schema: 2.0.0 @@ -226,5 +226,3 @@ Can create an in-memory object of type Microsoft.Rtc.Management.WritableConfig.P [New-CsVoiceRoute](New-CsVoiceRoute.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - - diff --git a/skype/skype-ps/skype/New-CsServerApplication.md b/skype/skype-ps/skype/New-CsServerApplication.md index 5470c049e7..00a0588174 100644 --- a/skype/skype-ps/skype/New-CsServerApplication.md +++ b/skype/skype-ps/skype/New-CsServerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skype/new-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsServerApplication schema: 2.0.0 @@ -141,7 +141,7 @@ Accept wildcard characters: False ### -Uri Unique Uniform Resource Identifier (URI) for the application. -For example, the QoEAgent application has the URI http://www.microsoft.com/LCS/QoEAgent. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml Type: String @@ -352,5 +352,3 @@ The New-CsServerApplication cmdlet creates new instances of the Microsoft.Rtc.Ma [Remove-CsServerApplication](Remove-CsServerApplication.md) [Set-CsServerApplication](Set-CsServerApplication.md) - - diff --git a/skype/skype-ps/skype/New-CsSimpleUrl.md b/skype/skype-ps/skype/New-CsSimpleUrl.md index 4bb48e1e3e..93d388cd74 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrl.md +++ b/skype/skype-ps/skype/New-CsSimpleUrl.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssimpleurl +online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurl applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSimpleUrl schema: 2.0.0 @@ -28,12 +28,12 @@ New-CsSimpleUrl -Component -Domain [-SimpleUrlEntry [-SimpleUrl [] In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are obviously an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -55,7 +55,7 @@ When you install Skype for Business Server, a global collection is created for y This gives you the ability to use different simple URLs at each of your sites. To add an actual URL to a simple URL collection, you must first create the URL by using the New-CsSimpleUrl cmdlet and the New-CsSimpleUrlEntry cmdlet. -The New-CsSimpleUrlEntry cmdlet creates a URL entry; this is nothing more than a URL (such as https://meet.litwareinc.com) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes). +The New-CsSimpleUrlEntry cmdlet creates a URL entry; this is nothing more than a URL (such as `https://meet.litwareinc.com`) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes). The object created by the New-CsSimpleUrlEntry cmdlet is then added to the SimpleUrlEntry property of a new simple URL. You must use a separate cmdlet to create the object; that's because the SimpleUrlEntry property can hold multiple URLs. (However, only one such URL can be designated as the active URL. @@ -80,10 +80,10 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` Example 1 shows how a new URL can be added to an existing collection of simple URLs. -To begin with, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To begin with, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. In the second command, the New-CsSimpleUrl cmdlet is used to create an in-memory-only instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com; and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com`; and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. After the URL has been created (and stored in the object reference $simpleUrl) the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter and the parameter value @{Add=$simpleUrl}. @@ -105,12 +105,12 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` In Example 2, a pair of URL entries is added to an existing collection of simple URLs. -To do this, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To do this, the first command in the example uses the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. The second command then creates a second URL entry, this one stored in the variable $urlEntry2 and pointing to the URL https:// dialin.fabrikam.com. After the two URL entries have been created, the New-CsSimpleUrl cmdlet is used to create two in-memory-only instances of a simple URL. -In the first instance, the URL Component is set to Meet; the domain is set to fabrikam.com; and the ActiveUrl is set to https://meet.fabrikam.com. -In the second instance, the component is set to Dialin; the domain to an asterisk (*); and the ActiveURL property is set to https://dialin.fabrikam.com. +In the first instance, the URL Component is set to Meet; the domain is set to fabrikam.com; and the ActiveUrl is set to `https://meet.fabrikam.com`. +In the second instance, the component is set to Dialin; the domain to an asterisk (*); and the ActiveURL property is set to `https://dialin.fabrikam.com`. After the URLs have been created (and stored in the object references $simpleUrl and $simpleUrl2), the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter, and the parameter value @{Add=$simpleUrl, $simpleUrl2}. @@ -163,5 +163,3 @@ The New-CsSimpleUrlEntry cmdlet creates new instances of the Microsoft.Rtc.Manag [New-CsSimpleUrl](New-CsSimpleUrl.md) [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) - - diff --git a/skype/skype-ps/skype/New-CsSipDomain.md b/skype/skype-ps/skype/New-CsSipDomain.md index 2225e7e23d..e3f6128773 100644 --- a/skype/skype-ps/skype/New-CsSipDomain.md +++ b/skype/skype-ps/skype/New-CsSipDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipDomain schema: 2.0.0 @@ -180,5 +180,3 @@ The New-CsSipDomain cmdlet creates new instances of the Microsoft.Rtc.Management [Remove-CsSipDomain](Remove-CsSipDomain.md) [Set-CsSipDomain](Set-CsSipDomain.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyCustom.md b/skype/skype-ps/skype/New-CsSipProxyCustom.md index e7adf2a7e5..1e9b87ddfd 100644 --- a/skype/skype-ps/skype/New-CsSipProxyCustom.md +++ b/skype/skype-ps/skype/New-CsSipProxyCustom.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxycustom +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxycustom applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyCustom schema: 2.0.0 @@ -85,5 +85,3 @@ The New-CsSipProxyCustom cmdlet creates new instances of the Microsoft.Rtc.Manag [New-CsSipProxyRealm](New-CsSipProxyRealm.md) [New-CsSipProxyUseDefault](New-CsSipProxyUseDefault.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyRealm.md b/skype/skype-ps/skype/New-CsSipProxyRealm.md index 96aa699307..28a9713563 100644 --- a/skype/skype-ps/skype/New-CsSipProxyRealm.md +++ b/skype/skype-ps/skype/New-CsSipProxyRealm.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxyrealm +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyrealm applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyRealm schema: 2.0.0 @@ -107,5 +107,3 @@ The New-CsSipProxyRealm cmdlet creates new instances of the Microsoft.Rtc.Manage [New-CsSipProxyCustom](New-CsSipProxyCustom.md) [New-CsSipProxyUseDefault](New-CsSipProxyUseDefault.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyTCP.md b/skype/skype-ps/skype/New-CsSipProxyTCP.md index 6d027f75dd..60a6fa4a29 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTCP.md +++ b/skype/skype-ps/skype/New-CsSipProxyTCP.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxytcp +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytcp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyTCP schema: 2.0.0 @@ -103,5 +103,3 @@ The New-CsSipProxyTCP cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsSipProxyTLS](New-CsSipProxyTLS.md) [New-CsSipProxyTransport](New-CsSipProxyTransport.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyTLS.md b/skype/skype-ps/skype/New-CsSipProxyTLS.md index 47bb0d1f72..8083398419 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTLS.md +++ b/skype/skype-ps/skype/New-CsSipProxyTLS.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxytls +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytls applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyTLS schema: 2.0.0 @@ -132,5 +132,3 @@ The New-CsSipProxyTLS cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsSipProxyTransport](New-CsSipProxyTransport.md) [New-CsSipProxyUseDefaultCert](New-CsSipProxyUseDefaultCert.md) - - diff --git a/skype/skype-ps/skype/New-CsSipProxyTransport.md b/skype/skype-ps/skype/New-CsSipProxyTransport.md index 060f63fdb8..3986103a26 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTransport.md +++ b/skype/skype-ps/skype/New-CsSipProxyTransport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxytransport +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytransport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyTransport schema: 2.0.0 @@ -134,4 +134,3 @@ The `New-CsSipProxyTransport` cmdlet creates new instances of the Microsoft.Rtc. [New-CsSipProxyTCP](New-CsSipProxyTCP.md) [New-CsSipProxyTLS](New-CsSipProxyTLS.md) - diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md b/skype/skype-ps/skype/New-CsSipProxyUseDefault.md index eefe9a81ac..c4b0c49aba 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md +++ b/skype/skype-ps/skype/New-CsSipProxyUseDefault.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxyusedefault +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefault applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyUseDefault schema: 2.0.0 @@ -80,4 +80,3 @@ The `New-CsSipProxyUseDefault` cmdlet creates new instances of the Microsoft.Rtc [New-CsSipProxyCustom](New-CsSipProxyCustom.md) [New-CsSipProxyRealm](New-CsSipProxyRealm.md) - diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md b/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md index 2fab300eea..c3e2de765f 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md +++ b/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipproxyusedefaultcert +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefaultcert applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipProxyUseDefaultCert schema: 2.0.0 @@ -97,4 +97,3 @@ The `New-CsSipProxyUseDefaultCert` cmdlet creates new instances of the Microsoft ## RELATED LINKS [New-CsSipProxyTLS](New-CsSipProxyTLS.md) - diff --git a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md index c532a631d6..79e5457a51 100644 --- a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsSipResponseCodeTranslationRule schema: 2.0.0 @@ -311,4 +311,3 @@ The `New-CsSipResponseCodeTranslationRule` cmdlet creates new instances of the M [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/New-CsStaticRoute.md b/skype/skype-ps/skype/New-CsStaticRoute.md index 80d607749c..f7208b4025 100644 --- a/skype/skype-ps/skype/New-CsStaticRoute.md +++ b/skype/skype-ps/skype/New-CsStaticRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csstaticroute +online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsStaticRoute schema: 2.0.0 @@ -326,4 +326,3 @@ The `New-CsStaticRoute` cmdlet creates new instances of the Microsoft.Rtc.Manage [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md index 263673ffb9..f59880c6ef 100644 --- a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsStaticRoutingConfiguration schema: 2.0.0 @@ -194,4 +194,3 @@ The `New-CsStaticRoutingConfiguration` cmdlet creates new instances of the Micro [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md index 348dc7e626..b9fb8758da 100644 --- a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsStorageServiceConfiguration schema: 2.0.0 @@ -226,4 +226,3 @@ The `New-CsStorageServiceConfiguration` cmdlet creates new instances of the Micr [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md deleted file mode 100644 index dba48ecc1a..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsappsetuppolicy -applicable: Skype for Business Online -title: New-CsTeamsAppSetupPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# New-CsTeamsAppSetupPolicy - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -``` -New-CsTeamsAppSetupPolicy [-Description ] [-AppPresetList ] [-WhatIf] - [-PinnedAppBarApps ] [-AllowUserPinning ] [-Confirm] [[-Identity] ] [-Tenant ] - [-InMemory] [-AllowSideLoading ] [-Force] [-AsJob] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally not provided - -## 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/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md deleted file mode 100644 index 177bc2a55b..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md +++ /dev/null @@ -1,469 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamscallingpolicy -applicable: Microsoft Teams -title: New-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# New-CsTeamsCallingPolicy - -## SYNOPSIS -Use this cmdlet to create a new instance of a Teams Calling Policy. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsCallingPolicy [-Identity] [-AllowCallForwardingToPhone ] [-AllowCallForwardingToUser ] [-AllowCallGroups ] -[-AllowCallRedirect ] [-AllowCloudRecordingForCalls ] [-AllowDelegation ] [-AllowPrivateCalling ] -[-AllowSIPDevicesCalling ] [-AllowTranscriptionForCalling ] [-AllowVoicemail ] [-AllowWebPSTNCalling ] -[-AutoAnswerEnabledType ] [-BusyOnBusyEnabledType ] [-CallRecordingExpirationDays ] [-Description ] -[-LiveCaptionsEnabledTypeForCalling ] [-MusicOnHoldEnabledType ] [-PopoutAppPathForIncomingPstnCalls ] [-PopoutForIncomingPstnCalls ] [-PreventTollBypass ] [-SpamFilteringEnabledType ] -[-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to create new policy instances. - -## EXAMPLES - -### Example 1 -``` -PS C:\> New-CsTeamsCallingPolicy -Identity Sales -AllowPrivateCalling $false -``` - -The cmdlet create the policy instance Sales and sets the value of the parameter AllowPrivateCalling to False. The rest of the parameters are set to the corresponding -values in the Global policy instance. - -## PARAMETERS - -### -Identity -Name of the policy instance being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallForwardingToPhone -Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallForwardingToUser -Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallGroups -Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallRedirect -Setting this parameter provides the ability to configure call redirection capabilities on Teams Phones. The valid options are: Enabled, Disabled, and UserOverride. When set to Enabled users will have the ability to redirect received calls. However, when set to Disabled the user will not have such ability. Note: The UserOverride option is not available for use. There's no UX implemented for its management. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCloudRecordingForCalls -Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDelegation -Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateCalling -Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. -If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSIPDevicesCalling -Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTranscriptionForCalling -Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoicemail -Enables inbound calls to be routed to voicemail. Valid options are: AlwaysEnabled, AlwaysDisabled, and UserOverride. When set to AlwaysDisabled, calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams. When set to AlwaysEnabled, calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user. When set to UserOverride, calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowWebPSTNCalling -Allows PSTN calling from the Team web client. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoAnswerEnabledType -Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams Phones. It is turned off by default. Valid options are Enabled and Disabled. This setting applies only to incoming meeting invites and does not include support for other call types. - - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BusyOnBusyEnabledType -Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: Enabled, Unanswered, and Disabled. When set to Enabled, new or incoming calls will be rejected with a busy signal. When set to Unanswered, the user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. Note: UserOverride option value is not available for use currently, if set it will be read as setting the value to Disabled. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallRecordingExpirationDays -Sets the expiration of the recorded 1:1 calls. Default is 60 days. - -```yaml -Type: Long -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiveCaptionsEnabledTypeForCalling -Determines whether real-time captions are available for the user in Teams calls. Set this to DisabledUserOverride to allow the user to turn on live captions. Set this to Disabled to prohibit. - - -Possible values: -- DisabledUserOverride -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldEnabledType -Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. It is turned on by default. Valid options are Enabled, Disabled, and UserOverride. For now, setting the value to UserOverride is the same as Enabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopoutAppPathForIncomingPstnCalls -Reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: "" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopoutForIncomingPstnCalls -Reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventTollBypass -Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. - -**Note**: Do not set this parameter to True for Calling Plan users as it will prevent successful call routing. This setting only works with Direct Routing which is configured to handle location-based routing restrictions. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpamFilteringEnabledType -Determines Spam filtering mode. - -Possible values: -- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. -- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. -- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -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: Microsoft Teams - -Required: False -Position: Named -Default value: False -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: Microsoft Teams - -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). - - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) - -[Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) - -[Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) - -[Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md deleted file mode 100644 index 8aad2e4971..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsemergencycallingpolicy -applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr -manager: roykuntz -ms.reviewer: chenc -schema: 2.0.0 ---- - -# New-CsTeamsEmergencyCallingPolicy - -## SYNOPSIS - -## SYNTAX - -``` -New-CsTeamsEmergencyCallingPolicy [-Identity] [-Description ] [-EnhancedEmergencyServiceDisclaimer ] - [-ExternalLocationLookupMode ] [-NotificationDialOutNumber ] [-NotificationGroup ] - [-NotificationMode ] [-WhatIf] [-Confirm] [] - ``` - -## DESCRIPTION -This cmdlet creates a new Teams Emergency Calling policy. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. - -## EXAMPLES - -### Example 1 -```powershell -New-CsTeamsEmergencyCallingPolicy -Identity testECP -Description "Test ECP" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode NotificationOnly -ExternalLocationLookupMode Enabled -``` - -This example creates a Teams Emergency Calling policy that has an identity of testECP, where a notification group and number is being defined, the external location lookup mode is enabled and also the type of notification. - -### Example 2 -```powershell -PS C:> New-CsTeamsEmergencyCallingPolicy -Identity "testECP2" -NotificationGroup "123@gh.com;567@test.com" -``` - - This example creates a Teams Emergency Calling policy that has an identity of testECP2, with default settings except for the Notification Group. This parameter expects a single string with all users and groups separated with ";". - -## PARAMETERS - -### -Identity - The Identity parameter is a unique identifier that designates the name of the policy - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter describes the Teams Emergency Calling policy - what it is for, what type of user it applies to and any other information that helps to identify the purpose of this policy. Maximum characters: 512. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnhancedEmergencyServiceDisclaimer -Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalLocationLookupMode -Enable ExternalLocationLookupMode. This mode allow users to set Emergency addresses for remote locations. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Disabled, Enabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. - -```yaml -Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode -Parameter Sets: (All) -Aliases: -Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS - -[Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) - -[Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) - -[Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) - -[Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) diff --git a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md deleted file mode 100644 index ea156311bb..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md +++ /dev/null @@ -1,415 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsmessagingpolicy -applicable: Skype for Business Online -title: New-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsTeamsMessagingPolicy - -## SYNOPSIS -The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. - -## SYNTAX - -``` -New-CsTeamsMessagingPolicy [-AllowOwnerDeleteMessage ] [-AllowSmartReply ] [-Description ] - [-AllowUserChat ] [[-Identity] ] [-InMemory] [-AllowUserDeleteMessage ] - [-ChannelsInChatListEnabledType ] [-Force] [-AllowStickers ] [-AllowUrlPreviews ] - [-Tenant ] [-AllowImmersiveReader ] [-AllowUserTranslation ] - [-AllowUserEditMessage ] [-AudioMessageEnabledType ] [-AllowRemoveUser ] - [-ReadReceiptsEnabledType ] [-AllowMemes ] [-Confirm] [-AllowPriorityMessages ] - [-WhatIf] [-GiphyRatingType ] [-AllowGiphy ] [-ChatPermissionRole ] - ``` - -## DESCRIPTION - The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet creates a new Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. - - -## EXAMPLES - -### Example 1 -``` -powershell -PS C:\> New-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false -``` - -In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. -All other policy properties will use the default values. - - -## PARAMETERS - -### -AllowGiphy -Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMemes -Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOwnerDeleteMessage -Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit. - -If the `-AllowUserDeleteMessage` parameter is set to FALSE, the team owner will not be able to delete their own messages. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickers -Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserChat -Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessage -Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserEditMessage -Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserTranslation -Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of your policy to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyRatingType -Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the teams messaging policy to be created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelsInChatListEnabledType -On mobile devices, enable to display favorite channels above recent chats. - -Possible values are: DisabledUserOverride,EnabledUserOverride. - -```yaml -Type: ChannelsInChatListEnabledTypeEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowImmersiveReader -Determines whether a user is allowed to use Immersive Reader for reading conversation messages. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AudioMessageEnabledType -Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels,ChatsOnly,Disabled. - -```yaml -Type: AudioMessageEnabledTypeEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowRemoveUser -Determines whether a user is allowed to remove a user from a conversation. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSmartReply -Turn this setting on to enable suggested replies for chat messages. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPriorityMessages -Determines whether a user is allowed to send priorities messages. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -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 -``` -### -ChatPermissionRole -Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the environment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Restricted -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md index dcd528c7ff..e0076883f9 100644 --- a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md @@ -1,8 +1,8 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsupgradepolicy -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsupgradepolicy +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTeamsUpgradePolicy schema: 2.0.0 manager: rogupta @@ -118,7 +118,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) diff --git a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md b/skype/skype-ps/skype/New-CsTelemetryConfiguration.md index e8511e1acb..8cff3d883a 100644 --- a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/New-CsTelemetryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTelemetryConfiguration schema: 2.0.0 @@ -164,4 +164,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTenantNetworkRegion.md b/skype/skype-ps/skype/New-CsTenantNetworkRegion.md deleted file mode 100644 index 8cb7086a24..0000000000 --- a/skype/skype-ps/skype/New-CsTenantNetworkRegion.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstenantnetworkregion -applicable: Skype for Business Online -title: New-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# New-CsTenantNetworkRegion - -## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, New-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region, and has no dependencies or restrictions. Tenant network region is used for Location Based Routing. - -## SYNTAX - -### Identity (Default) -``` -New-CsTenantNetworkRegion [-Tenant ] [-Description ] [-BypassID ] - [-CentralSite ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### ParentAndRelativeKey -``` -New-CsTenantNetworkRegion -NetworkRegionID [-Tenant ] [-Description ] - [-BypassID ] [-CentralSite ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. - -## EXAMPLES - -###-------------------------- Example 1 -------------------------- -```powershell -PS C:\> New-CsTenantNetworkRegion -NetworkRegionID "RegionA" -``` - -The command shown in Example 1 created the network region 'RegionA' with no description. Identity and CentralSite will both be set identical with NetworkRegionID. - -Previously in Skype for Business there was an additional required parameter `-CentralSite `, however it is now optional. - -###-------------------------- Example 2 -------------------------- -```powershell -PS C:\> New-CsTenantNetworkRegion -NetworkRegionID "RegionRedmond" -Description "Redmond region" -CentralSite "Central site 1" -``` - -The command shown in Example 2 created the network region 'RegionRedmond' with description 'Redmond region'. CentralSite is set to "Central site 1". - -## PARAMETERS - -### -BypassID -Bypass ID was not required and not used in current commands. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CentralSite -This parameter is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of the network region to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the network region to be created. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkRegionID -The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network regions are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md index 5fd198b0fe..11a5b21e8e 100644 --- a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skype/new-cstenantupdatetimewindow applicable: Skype for Business Online title: New-CsTenantUpdateTimeWindow schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsTenantUpdateTimeWindow @@ -337,4 +337,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsTestDevice.md b/skype/skype-ps/skype/New-CsTestDevice.md index 946c6c0809..74d4439948 100644 --- a/skype/skype-ps/skype/New-CsTestDevice.md +++ b/skype/skype-ps/skype/New-CsTestDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skype/new-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTestDevice schema: 2.0.0 @@ -267,4 +267,3 @@ Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.De [Remove-CsTestDevice](Remove-CsTestDevice.md) [Set-CsTestDevice](Set-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md index 72e23d2651..b99a3a2d81 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsThirdPartyVideoSystem schema: 2.0.0 @@ -256,4 +256,3 @@ The `New-CsThirdPartyVideoSystem` cmdlet creates new instances of the Microsoft. [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md index 67bafce935..4043433c11 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsThirdPartyVideoSystemPolicy schema: 2.0.0 @@ -196,4 +196,3 @@ The `New-CsThirdPartyVideoSystemPolicy` cmdlet creates new instances of the Micr [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsTrunkConfiguration.md b/skype/skype-ps/skype/New-CsTrunkConfiguration.md index 4039624768..f7e31d7df2 100644 --- a/skype/skype-ps/skype/New-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/New-CsTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTrunkConfiguration schema: 2.0.0 @@ -724,4 +724,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Trunk [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplication.md b/skype/skype-ps/skype/New-CsTrustedApplication.md index 18dc245ff7..a46ee864c0 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplication.md +++ b/skype/skype-ps/skype/New-CsTrustedApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTrustedApplication schema: 2.0.0 @@ -263,4 +263,3 @@ Creates an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication [Set-CsTrustedApplication](Set-CsTrustedApplication.md) [Get-CsTrustedApplication](Get-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md b/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md index b4650c484b..1f2dd613a9 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstrustedapplicationcomputer +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTrustedApplicationComputer schema: 2.0.0 @@ -156,4 +156,3 @@ Creates an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. [New-CsTrustedApplicationPool](New-CsTrustedApplicationPool.md) [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md index 2ef6736315..9013c9e9a4 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTrustedApplicationEndpoint schema: 2.0.0 @@ -292,4 +292,3 @@ Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplica [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md b/skype/skype-ps/skype/New-CsTrustedApplicationPool.md index 76d4eb2de9..cd945137d5 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/New-CsTrustedApplicationPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTrustedApplicationPool schema: 2.0.0 @@ -412,4 +412,3 @@ Creates an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) [Get-CsSite](Get-CsSite.md) - diff --git a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md index 022c8e3579..30a0ec713e 100644 --- a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csucphoneconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsUCPhoneConfiguration schema: 2.0.0 @@ -354,4 +354,3 @@ Creates instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Uc [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsUnassignedNumber.md b/skype/skype-ps/skype/New-CsUnassignedNumber.md index 32317e3c0a..963f52646a 100644 --- a/skype/skype-ps/skype/New-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/New-CsUnassignedNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skype/new-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsUnassignedNumber schema: 2.0.0 @@ -308,4 +308,3 @@ Creates an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnounce [Get-CsAnnouncement](Get-CsAnnouncement.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md index 84ad592acb..285f45e328 100644 --- a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csuserreplicatorconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsUserReplicatorConfiguration schema: 2.0.0 @@ -249,4 +249,3 @@ The `New-CsUserReplicatorConfiguration` cmdlet creates new instances of the Micr [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md b/skype/skype-ps/skype/New-CsUserServicesConfiguration.md index e0468d4c56..6a6f17e252 100644 --- a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/New-CsUserServicesConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csuserservicesconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsUserServicesConfiguration schema: 2.0.0 @@ -445,4 +445,3 @@ The `New-CsUserServicesConfiguration` cmdlet creates new instances of the Micros [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsUserServicesPolicy.md b/skype/skype-ps/skype/New-CsUserServicesPolicy.md index 8695591188..d9608afa86 100644 --- a/skype/skype-ps/skype/New-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/New-CsUserServicesPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsUserServicesPolicy schema: 2.0.0 @@ -254,4 +254,3 @@ The `New-CsUserServicesPolicy` cmdlet creates new instances of the Microsoft.Rtc [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md index 191733e3b2..3c55431495 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvideointeropserverconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVideoInteropServerConfiguration schema: 2.0.0 @@ -185,4 +185,3 @@ The `New-CsVideoInteropServerConfiguration` cmdlet creates new instances of the [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md index c32be64dce..090e344050 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvideointeropserversynthetictransactionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVideoInteropServerSyntheticTransactionConfiguration schema: 2.0.0 @@ -179,4 +179,3 @@ Returns a VideoInteropServerSyntheticTransactionConfiguration object. [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md index bc8bfc3371..554d14112c 100644 --- a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvideotrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVideoTrunkConfiguration schema: 2.0.0 @@ -32,7 +32,7 @@ The Video Interop Server is a Skype service that runs on a standalone pool and c To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -264,4 +264,3 @@ The `New-CsVideoTrunkConfiguration` cmdlet creates new instances of the Microsof [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md index 54e35ab23b..9404a4f7ca 100644 --- a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoicenormalizationrule -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicenormalizationrule +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceNormalizationRule schema: 2.0.0 manager: bulenteg author: jenstrier -ms.author: jenstr +ms.author: serdars --- # New-CsVoiceNormalizationRule @@ -383,6 +383,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsDialPlan](Get-CsDialPlan.md) -[New-CsTenantDialPlan](New-CsTenantDialPlan.md) - -[Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) diff --git a/skype/skype-ps/skype/New-CsVoicePolicy.md b/skype/skype-ps/skype/New-CsVoicePolicy.md index 7a0347ea73..1f0e3f4982 100644 --- a/skype/skype-ps/skype/New-CsVoicePolicy.md +++ b/skype/skype-ps/skype/New-CsVoicePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoicePolicy schema: 2.0.0 @@ -601,4 +601,3 @@ This cmdlet creates an instance of the Microsoft.Rtc.Management.WritableConfig.V [Test-CsVoicePolicy](Test-CsVoicePolicy.md) [Get-CsPstnUsage](Get-CsPstnUsage.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceRegex.md b/skype/skype-ps/skype/New-CsVoiceRegex.md index def2b44ee6..dfa493a3db 100644 --- a/skype/skype-ps/skype/New-CsVoiceRegex.md +++ b/skype/skype-ps/skype/New-CsVoiceRegex.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoiceregex -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceregex +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceRegex schema: 2.0.0 manager: bulenteg @@ -193,4 +193,3 @@ Creates on object of type Microsoft.Rtc.Management.Voice.OcsVoiceRegex. [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) [New-CsVoiceRoute](New-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceRoute.md b/skype/skype-ps/skype/New-CsVoiceRoute.md index deebe0fda1..f6633618bd 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoute.md +++ b/skype/skype-ps/skype/New-CsVoiceRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceRoute schema: 2.0.0 @@ -362,4 +362,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.R [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md index fa21fd1d59..f6a0bd7f8b 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceRoutingPolicy schema: 2.0.0 @@ -219,4 +219,3 @@ The `New-CsVoiceRoutingPolicy` cmdlet creates new instances of Microsoft.Rtc.Man [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md index 4ee948ada8..bff35169f4 100644 --- a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoiceTestConfiguration schema: 2.0.0 @@ -344,4 +344,3 @@ This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsDialPlan](Get-CsDialPlan.md) [Get-CsVoicePolicy](Get-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md index 081e466dcc..58bcb680ea 100644 --- a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvoicemailreroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsVoicemailReroutingConfiguration schema: 2.0.0 @@ -224,4 +224,3 @@ Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumR [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md index 14f1d564ca..7127cbf0ec 100644 --- a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWatcherNodeConfiguration schema: 2.0.0 @@ -361,4 +361,3 @@ The `New-CsWatcherNodeConfiguration` cmdlet creates new instances of the Microso ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsWebLink.md b/skype/skype-ps/skype/New-CsWebLink.md index 9db20e8d25..56cf68d55b 100644 --- a/skype/skype-ps/skype/New-CsWebLink.md +++ b/skype/skype-ps/skype/New-CsWebLink.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csweblink -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csweblink +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebLink schema: 2.0.0 manager: rogupta @@ -47,7 +47,7 @@ When you install Skype for Business Server a global collection of settings will Managing Autodiscover configuration settings typically means adding Autodiscover URLs. These URLs must be created using the `New-CsWebLink` cmdlet, with the resulting URL stored in a variable and then added to a collection of Autodiscover configuration settings. -Autodiscover URLs are based on the SIP domains used in your organization; administrators will typically create one URL for use by users outside the organization's firewall (for example, https://LyncDiscover.litwareinc.com) and a second URL (for example, https://LyncDiscoverInternal.litwareinc.com) for use by users inside the firewall. +Autodiscover URLs are based on the SIP domains used in your organization; administrators will typically create one URL for use by users outside the organization's firewall (for example, `https://LyncDiscover.litwareinc.com`) and a second URL (for example, `https://LyncDiscoverInternal.litwareinc.com``) for use by users inside the firewall. ## EXAMPLES @@ -59,7 +59,7 @@ $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.co Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1} ``` -The commands shown in Example 1 add a new Autodiscover URL (https://LyncDiscover.fabrikam.com) to the Autodiscover configuration settings assigned to the Redmond site. +The commands shown in Example 1 add a new Autodiscover URL (`https://LyncDiscover.fabrikam.com`) to the Autodiscover configuration settings assigned to the Redmond site. To do this, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL; that URL is stored in a variable named $Link1. After that, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to add the new URL to any URLs already assigned to these settings. This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. @@ -74,7 +74,7 @@ $Link2 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscoverInternal.fab Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1,$Link2} ``` -The commands in Example 2 assign a pair of Autodiscover URLs (https://LyncDiscover.fabrikam.com and https://LyncDiscoverInternal.fabrikam.com) to the Autodiscover configuration settings assigned to the Redmond site.. +The commands in Example 2 assign a pair of Autodiscover URLs (`https://LyncDiscover.fabrikam.com` and `https://LyncDiscoverInternal.fabrikam.com`) to the Autodiscover configuration settings assigned to the Redmond site.. In order to carry out this task, the first two commands use the `New-CsWebLink` cmdlet to create the two Autodiscover URLs; the newly-created URLs are then stored in variables named $Link1 and $Link2. After the two URLs are created, the third command uses the `Set-CsAutoDiscoverConfiguration` cmdlet to assign the two URLs to the Redmond site. To do this, the WebLinks parameter is included along with the parameter value @{Add=$Link1,$Link2}. @@ -137,4 +137,3 @@ Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.W ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsWebOrigin.md b/skype/skype-ps/skype/New-CsWebOrigin.md index 9ba77fedc5..f4c97376ec 100644 --- a/skype/skype-ps/skype/New-CsWebOrigin.md +++ b/skype/skype-ps/skype/New-CsWebOrigin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csweborigin -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/new-csweborigin +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebOrigin schema: 2.0.0 manager: rogupta @@ -107,4 +107,3 @@ The `New-CsWebOrigin` cmdlet creates new instances of the Microsoft.Rtc.Manageme [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md b/skype/skype-ps/skype/New-CsWebServiceConfiguration.md index 45118be458..8b4f16252e 100644 --- a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/New-CsWebServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cswebserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/new-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebServiceConfiguration schema: 2.0.0 diff --git a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md b/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md index 5dead0cb26..1ae3b83bb3 100644 --- a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md +++ b/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cswebtrustedcacertificate +online version: https://learn.microsoft.com/powershell/module/skype/new-cswebtrustedcacertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebTrustedCACertificate schema: 2.0.0 @@ -119,4 +119,3 @@ The `New-CsWebTrustedCACertificate` cmdlet creates new instances of the Microsof [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md b/skype/skype-ps/skype/New-CsXmppAllowedPartner.md index 8d1eff00a8..3143cc1192 100644 --- a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/New-CsXmppAllowedPartner.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/new-csxmppallowedpartner +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta @@ -392,4 +392,3 @@ The `New-CsXmppAllowedPartner` cmdlet creates new instances of the Microsoft.Rtc [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Publish-CsLisConfiguration.md b/skype/skype-ps/skype/Publish-CsLisConfiguration.md index 56718586f7..a3a95573fd 100644 --- a/skype/skype-ps/skype/Publish-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Publish-CsLisConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/publish-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/publish-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Publish-CsLisConfiguration schema: 2.0.0 @@ -117,4 +117,3 @@ This cmdlet does not return a value. [Export-CsLisConfiguration](Export-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Publish-CsTopology.md b/skype/skype-ps/skype/Publish-CsTopology.md index 1aa7b9aee1..a947773c93 100644 --- a/skype/skype-ps/skype/Publish-CsTopology.md +++ b/skype/skype-ps/skype/Publish-CsTopology.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/publish-cstopology +online version: https://learn.microsoft.com/powershell/module/skype/publish-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Publish-CsTopology schema: 2.0.0 @@ -268,4 +268,3 @@ Instead, the `Publish-CsTopology` cmdlet publishes instances of the Microsoft.Rt [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) [Test-CsTopology](Test-CsTopology.md) - diff --git a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md index 565ab618af..9dcace377f 100644 --- a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/register-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance applicable: Skype for Business Online title: Register-CsHybridPSTNAppliance schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Register-CsHybridPSTNAppliance @@ -203,4 +203,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md index bf9f54b89d..37d8b834d3 100644 --- a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAVEdgeConfiguration schema: 2.0.0 @@ -165,4 +165,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsAVEdgeConfiguration](New-CsAVEdgeConfiguration.md) [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md b/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md index 6207f4e8de..9840f5844b 100644 --- a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain +online version: https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAdditionalInternalDomain schema: 2.0.0 @@ -120,6 +120,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsAdditionalInternalDomain](https://docs.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain?view=skype-ps) +[New-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain?view=skype-ps) -[Get-CsAdditionalInternalDomain](https://docs.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) +[Get-CsAdditionalInternalDomain](https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md b/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md index 5853a00ea6..6462ca6564 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAddressBookConfiguration schema: 2.0.0 @@ -167,4 +167,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [New-CsAddressBookConfiguration](New-CsAddressBookConfiguration.md) [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md index d9e4638be9..5aa40f5cda 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAddressBookNormalizationConfiguration schema: 2.0.0 @@ -152,4 +152,3 @@ Instead, the `Remove-CsAddressBookNormalizationConfiguration` cmdlet deletes exi [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md index 0a24c7f6de..b1f7133ca9 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAddressBookNormalizationRule schema: 2.0.0 @@ -152,4 +152,3 @@ Instead, the `Remove-CsAddressBookNormalizationRule` cmdlet deletes existing ins [New-CsAddressBookNormalizationRule](New-CsAddressBookNormalizationRule.md) [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsAdminRole.md b/skype/skype-ps/skype/Remove-CsAdminRole.md index 14f44ad7c8..0902573360 100644 --- a/skype/skype-ps/skype/Remove-CsAdminRole.md +++ b/skype/skype-ps/skype/Remove-CsAdminRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csadminrole +online version: https://learn.microsoft.com/powershell/module/skype/remove-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAdminRole schema: 2.0.0 @@ -255,4 +255,3 @@ The `Remove-CsAdminRole` cmdlet deletes existing instances of the Microsoft.Rtc. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsAllowedDomain.md b/skype/skype-ps/skype/Remove-CsAllowedDomain.md index 36a0d15e75..369b896c1d 100644 --- a/skype/skype-ps/skype/Remove-CsAllowedDomain.md +++ b/skype/skype-ps/skype/Remove-CsAllowedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skype/remove-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAllowedDomain schema: 2.0.0 @@ -176,4 +176,3 @@ Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.A [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsAllowedDomain](Set-CsAllowedDomain.md) - diff --git a/skype/skype-ps/skype/Remove-CsAnalogDevice.md b/skype/skype-ps/skype/Remove-CsAnalogDevice.md index a6a43e23ba..2934cae81d 100644 --- a/skype/skype-ps/skype/Remove-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Remove-CsAnalogDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skype/remove-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAnalogDevice schema: 2.0.0 @@ -159,4 +159,3 @@ The `Remove-CsAnalogDevice` cmdlet deletes existing instances of the Microsoft.R [New-CsAnalogDevice](New-CsAnalogDevice.md) [Set-CsAnalogDevice](Set-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Remove-CsAnnouncement.md b/skype/skype-ps/skype/Remove-CsAnnouncement.md index df574aad85..b51ed922b3 100644 --- a/skype/skype-ps/skype/Remove-CsAnnouncement.md +++ b/skype/skype-ps/skype/Remove-CsAnnouncement.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csannouncement +online version: https://learn.microsoft.com/powershell/module/skype/remove-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAnnouncement schema: 2.0.0 @@ -149,4 +149,3 @@ Deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settin [Set-CsAnnouncement](Set-CsAnnouncement.md) [Get-CsAnnouncement](Get-CsAnnouncement.md) - diff --git a/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md deleted file mode 100644 index 47f8b0b6f4..0000000000 --- a/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csapplicationaccesspolicy -applicable: Skype for Business Online -title: Remove-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni -author: frankpeng7 -ms.author: frpeng -ms.reviewer: ---- - -# Remove-CsApplicationAccessPolicy - -## SYNOPSIS - -Deletes an existing application access policy. - -## SYNTAX - -### Identity - -``` -Remove-CsApplicationAccessPolicy [-Identity ] -``` - -## DESCRIPTION - -This cmdlet deletes an existing application access policy. - -## EXAMPLES - -### Remove an application access policy - -``` -PS C:\> Remove-CsApplicationAccessPolicy -Identity "ASimplePolicy" -``` - -The command shown above deletes the application access policy ASimplePolicy. - -## PARAMETERS - -### -Identity - -Unique identifier assigned to the policy when it was created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) diff --git a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md b/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md index c5ea7d6357..cd4dcbd64d 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsArchivingConfiguration schema: 2.0.0 @@ -182,4 +182,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md b/skype/skype-ps/skype/Remove-CsArchivingPolicy.md index 43c7d0f5f5..aad1e6bdd9 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsArchivingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsArchivingPolicy schema: 2.0.0 @@ -214,4 +214,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [New-CsArchivingPolicy](New-CsArchivingPolicy.md) [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md index 579e937cab..28d818613b 100644 --- a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsAutodiscoverConfiguration schema: 2.0.0 manager: rogupta @@ -161,4 +161,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableC ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md index 3789a1234c..c6a0bc6cfc 100644 --- a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csbackupserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsBackupServiceConfiguration schema: 2.0.0 @@ -135,4 +135,3 @@ Instead, the `Remove-CsBackupServiceConfiguration` cmdlet deletes instances of t [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md index fba0244e50..41f3e9cac6 100644 --- a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsBandwidthPolicyServiceConfiguration schema: 2.0.0 @@ -146,4 +146,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ba [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsBlockedDomain.md b/skype/skype-ps/skype/Remove-CsBlockedDomain.md index ca81a96432..29b6a48035 100644 --- a/skype/skype-ps/skype/Remove-CsBlockedDomain.md +++ b/skype/skype-ps/skype/Remove-CsBlockedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skype/remove-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsBlockedDomain schema: 2.0.0 @@ -167,4 +167,3 @@ Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.B [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) [Set-CsBlockedDomain](Set-CsBlockedDomain.md) - diff --git a/skype/skype-ps/skype/Remove-CsBusyOptions.md b/skype/skype-ps/skype/Remove-CsBusyOptions.md index 01aa55a8fb..3a462337d7 100644 --- a/skype/skype-ps/skype/Remove-CsBusyOptions.md +++ b/skype/skype-ps/skype/Remove-CsBusyOptions.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csbusyoptions +online version: https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsBusyOptions schema: 2.0.0 @@ -118,6 +118,6 @@ This cmdlet does not return any objects. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://docs.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) -[Set-CsBusyOptions](https://docs.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) +[Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md b/skype/skype-ps/skype/Remove-CsCallParkOrbit.md index d674478bb5..c2fc47f998 100644 --- a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/Remove-CsCallParkOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsCallParkOrbit schema: 2.0.0 @@ -152,4 +152,3 @@ It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallP [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) - diff --git a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md index 9de3cc0cfa..80f2007953 100644 --- a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsCallViaWorkPolicy schema: 2.0.0 @@ -149,4 +149,3 @@ None. [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md b/skype/skype-ps/skype/Remove-CsCdrConfiguration.md index dc5548065d..fd052dd951 100644 --- a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsCdrConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsCdrConfiguration schema: 2.0.0 @@ -170,4 +170,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsCdrConfiguration](New-CsCdrConfiguration.md) [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsCertificate.md b/skype/skype-ps/skype/Remove-CsCertificate.md index 94317013b4..f66a9b06f6 100644 --- a/skype/skype-ps/skype/Remove-CsCertificate.md +++ b/skype/skype-ps/skype/Remove-CsCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscertificate +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsCertificate schema: 2.0.0 diff --git a/skype/skype-ps/skype/Remove-CsClientPolicy.md b/skype/skype-ps/skype/Remove-CsClientPolicy.md index 42c70999a6..dad1f49490 100644 --- a/skype/skype-ps/skype/Remove-CsClientPolicy.md +++ b/skype/skype-ps/skype/Remove-CsClientPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclientpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClientPolicy schema: 2.0.0 manager: bulenteg @@ -194,4 +194,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsClientPolicy](New-CsClientPolicy.md) [Set-CsClientPolicy](Set-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md b/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md index 2e35e6db34..fee4af8bf2 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClientVersionConfiguration schema: 2.0.0 @@ -167,4 +167,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsClientVersionConfiguration](New-CsClientVersionConfiguration.md) [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md b/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md index 160ae4b397..73274296e7 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClientVersionPolicy schema: 2.0.0 @@ -196,4 +196,3 @@ The `Remove-CsClientVersionPolicy` cmdlet deletes existing instances of the Micr [New-CsClientVersionPolicy](New-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md index 9e3dc51636..9ab5db8977 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClientVersionPolicyRule schema: 2.0.0 @@ -214,4 +214,3 @@ Instead, the `Remove-CsClientVersionPolicyRule` cmdlet deletes instances of the [New-CsClientVersionPolicyRule](New-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsClsConfiguration.md b/skype/skype-ps/skype/Remove-CsClsConfiguration.md index 9311fa7837..2e6f11933a 100644 --- a/skype/skype-ps/skype/Remove-CsClsConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsClsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClsConfiguration schema: 2.0.0 @@ -177,4 +177,3 @@ Instead, the `Remove-CsClsConfiguration` cmdlet deletes existing instances of th [New-CsClsConfiguration](New-CsClsConfiguration.md) [Set-CsClsConfiguration](Set-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsClsRegion.md b/skype/skype-ps/skype/Remove-CsClsRegion.md index 6fea4cc0ff..d453a56054 100644 --- a/skype/skype-ps/skype/Remove-CsClsRegion.md +++ b/skype/skype-ps/skype/Remove-CsClsRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclsregion +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClsRegion schema: 2.0.0 @@ -161,4 +161,3 @@ Instead, the `Remove-CsClsRegion` cmdlet deletes existing instances of the Micro [New-CsClsRegion](New-CsClsRegion.md) [Set-CsClsRegion](Set-CsClsRegion.md) - diff --git a/skype/skype-ps/skype/Remove-CsClsScenario.md b/skype/skype-ps/skype/Remove-CsClsScenario.md index d35c83f045..c1cf3ade17 100644 --- a/skype/skype-ps/skype/Remove-CsClsScenario.md +++ b/skype/skype-ps/skype/Remove-CsClsScenario.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClsScenario schema: 2.0.0 @@ -152,4 +152,3 @@ Instead, the `Remove-CsClsScenario` cmdlet deletes existing instances of the Mic ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md b/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md index 1c93177b0a..823296de5b 100644 --- a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsClsSecurityGroup schema: 2.0.0 @@ -161,4 +161,3 @@ Instead, the `Remove-CsClsSecurityGroup` cmdlet deletes existing instances of th [New-CsClsSecurityGroup](New-CsClsSecurityGroup.md) [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md b/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md index 29800c17dc..2a890219dc 100644 --- a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsCommonAreaPhone schema: 2.0.0 @@ -156,4 +156,3 @@ The `Remove-CsCommonAreaPhone` cmdlet deletes existing instances of the Microsof [New-CsCommonAreaPhone](New-CsCommonAreaPhone.md) [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md b/skype/skype-ps/skype/Remove-CsConferenceDirectory.md index 1a75ffa405..407a22cf8c 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md +++ b/skype/skype-ps/skype/Remove-CsConferenceDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csconferencedirectory +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConferenceDirectory schema: 2.0.0 @@ -151,4 +151,3 @@ Instead, the `Removes-CsConferenceDirectory` cmdlet deletes instances of the Mic [Move-CsConferenceDirectory](Move-CsConferenceDirectory.md) [New-CsConferenceDirectory](New-CsConferenceDirectory.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md b/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md index c6fcab1403..efd4048142 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md +++ b/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csconferencedisclaimer +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConferenceDisclaimer schema: 2.0.0 @@ -135,4 +135,3 @@ Instead, the `Remove-CsConferenceDisclaimer` cmdlet resets existing instances of [Get-CsConferenceDisclaimer](Get-CsConferenceDisclaimer.md) [Set-CsConferenceDisclaimer](Set-CsConferenceDisclaimer.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md b/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md index 92afeb9850..4164a16021 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConferencingConfiguration schema: 2.0.0 @@ -177,4 +177,3 @@ Instead, the `Remove-CsConferencingConfiguration` cmdlet deletes existing instan [New-CsConferencingConfiguration](New-CsConferencingConfiguration.md) [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md b/skype/skype-ps/skype/Remove-CsConferencingPolicy.md index b30958e001..cbc2051711 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Remove-CsConferencingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csconferencingpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConferencingPolicy schema: 2.0.0 manager: bulenteg @@ -205,4 +205,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsConferencingPolicy](New-CsConferencingPolicy.md) [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md b/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md index 2ed3f24c91..654ff393a0 100644 --- a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csconfigurationstorelocation +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConfigurationStoreLocation schema: 2.0.0 @@ -165,4 +165,3 @@ The `Remove-CsConfigurationStoreLocation` cmdlet does not return any objects or [Get-CsConfigurationStoreLocation](Get-CsConfigurationStoreLocation.md) [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md b/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md index 783c46e4f8..1d6e47fc07 100644 --- a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csconversationhistoryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsConversationHistoryConfiguration schema: 2.0.0 @@ -137,4 +137,3 @@ Instead, `Remove-CsConversationHistoryConfiguration` resets instances of the Mic [Get-CsConversationHistoryConfiguration](Get-CsConversationHistoryConfiguration.md) [Set-CsConversationHistoryConfiguration](Set-CsConversationHistoryConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md b/skype/skype-ps/skype/Remove-CsCpsConfiguration.md index b2da6a421b..31f01a2608 100644 --- a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsCpsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsCpsConfiguration schema: 2.0.0 @@ -151,4 +151,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallP [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md index 2891fd0ac7..3ba03e403a 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDeviceUpdateConfiguration schema: 2.0.0 @@ -178,4 +178,3 @@ Instead, the `Remove-CsDeviceUpdateConfiguration` cmdlet deletes instances of th [New-CsDeviceUpdateConfiguration](New-CsDeviceUpdateConfiguration.md) [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md b/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md index ead2aa7c26..f13625d1e3 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md +++ b/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdeviceupdaterule +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDeviceUpdateRule schema: 2.0.0 @@ -174,4 +174,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md index 46315b185e..863e71f71f 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDiagnosticConfiguration schema: 2.0.0 @@ -167,4 +167,3 @@ Instead, the `Remove-CsDiagnosticConfiguration` cmdlet deletes existing instance [New-CsDiagnosticConfiguration](New-CsDiagnosticConfiguration.md) [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md index 703701dabb..5b42883a96 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDiagnosticHeaderConfiguration schema: 2.0.0 @@ -172,4 +172,3 @@ Instead, the `Remove-CsDiagnosticHeaderConfiguration` cmdlet deletes existing in [New-CsDiagnosticHeaderConfiguration](New-CsDiagnosticHeaderConfiguration.md) [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md index 9d4e4184dd..7f4137e2f9 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDialInConferencingAccessNumber schema: 2.0.0 @@ -172,4 +172,3 @@ The `Remove-CsDialInConferencingAccessNumber` cmdlet deletes instances of the Mi [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md index 87d15b22a4..e0c94267aa 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDialInConferencingConfiguration schema: 2.0.0 @@ -166,4 +166,3 @@ Instead, the `Remove-CSDialInConferencingConfiguration` cmdlet deletes instances [New-CsDialInConferencingConfiguration](New-CsDialInConferencingConfiguration.md) [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md index a05dbf0b6e..8eaaf5a8d7 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDialInConferencingDtmfConfiguration schema: 2.0.0 @@ -171,4 +171,3 @@ Instead, the `Remove-CSDialInConferencingDtmfConfiguration` cmdlet deletes insta [New-CsDialInConferencingDtmfConfiguration](New-CsDialInConferencingDtmfConfiguration.md) [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsDialPlan.md b/skype/skype-ps/skype/Remove-CsDialPlan.md index 162b10d712..e42285747c 100644 --- a/skype/skype-ps/skype/Remove-CsDialPlan.md +++ b/skype/skype-ps/skype/Remove-CsDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csdialplan +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsDialPlan schema: 2.0.0 @@ -155,4 +155,3 @@ This cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Pol [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md index 06c5d57e43..12953178d6 100644 --- a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csenhancedemergencyservicedisclaimer +online version: https://learn.microsoft.com/powershell/module/skype/remove-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsEnhancedEmergencyServiceDisclaimer schema: 2.0.0 @@ -134,4 +134,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Loc [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) [Get-CsLocationPolicy](Get-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsExUmContact.md b/skype/skype-ps/skype/Remove-CsExUmContact.md index dc2dd8f351..264bd46774 100644 --- a/skype/skype-ps/skype/Remove-CsExUmContact.md +++ b/skype/skype-ps/skype/Remove-CsExUmContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsExUmContact schema: 2.0.0 @@ -131,4 +131,3 @@ It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUm [Get-CsExUmContact](Get-CsExUmContact.md) [Move-CsExUmContact](Move-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md index 8a09be45ec..d10506b89c 100644 --- a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csexternalaccesspolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalaccesspolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsExternalAccessPolicy schema: 2.0.0 manager: bulenteg @@ -14,10 +14,9 @@ ms.reviewer: rogupta ## SYNOPSIS Enables you to remove an existing external access policy. -External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live and 3) access Skype for Business Server over the Internet, without having to log on to your internal network. +External access policies determine whether or not your users can: 1) Communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) Communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; 3) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop) and 4) Access Skype for Business Server over the Internet, without having to log on to your internal network. This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ``` @@ -29,18 +28,17 @@ Remove-CsExternalAccessPolicy [-Tenant ] [-Identity] [-Force When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. -1. -That might be sufficient to meet your communication needs. +1. That might be sufficient to meet your communication needs. If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -2. -Communicate with people who have SIP accounts with a federated organization. +2. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -3. -Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. +3. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. @@ -53,7 +51,6 @@ You can also run the `Remove-CsExternalAccessPolicy` cmdlet against the global e In that case, however, the global policies will not be deleted; by design, global policies cannot be deleted. Instead, the properties of the global policy will simply be reset to their default values. - ## EXAMPLES ### -------------------------- Example 1 ------------------------ @@ -64,7 +61,6 @@ Remove-CsExternalAccessPolicy -Identity site:Redmond In Example 1, the external access policy with the Identity site:Redmond is deleted. After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. - ### -------------------------- Example 2 ------------------------ ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy @@ -74,7 +70,6 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. - ### -------------------------- Example 3 ------------------------ ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy @@ -85,7 +80,6 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. - ### -------------------------- Example 4 ------------------------ ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy @@ -100,7 +94,6 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo `Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True}` - ## PARAMETERS ### -Identity @@ -113,11 +106,10 @@ To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessP Note that wildcards are not allowed when specifying an Identity. - ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True @@ -130,11 +122,10 @@ Accept wildcard characters: False ### -Force Suppresses the display of any non-fatal error message that might occur when running the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -147,7 +138,6 @@ Accept wildcard characters: False ### -WhatIf Describes what would happen if you executed the command without actually executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -164,7 +154,6 @@ Accept wildcard characters: False ### -Confirm Prompts you for confirmation before executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -188,11 +177,10 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` - ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -229,4 +217,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md index 54d5a33e6e..a7a6576fd6 100644 --- a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy applicable: Skype for Business Online title: Remove-CsExternalUserCommunicationPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsExternalUserCommunicationPolicy @@ -131,4 +131,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md b/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md index 02e27ad528..21351e05ab 100644 --- a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsFIPSConfiguration schema: 2.0.0 @@ -169,4 +169,3 @@ Instead, the `Remove-CsFIPSConfiguration` cmdlet deletes existing instances of t [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md index 162e27f702..bcffa2634d 100644 --- a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsFileTransferFilterConfiguration schema: 2.0.0 @@ -160,4 +160,3 @@ Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Set [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md index 0a97ba8877..f6a9d6484e 100644 --- a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skype/remove-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsGroupPickupUserOrbit schema: 2.0.0 @@ -124,4 +124,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md index 97e5a7ea90..d7ea78fe80 100644 --- a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsHealthMonitoringConfiguration schema: 2.0.0 @@ -175,4 +175,3 @@ Instead, the `Remove-CsHealthMonitoringConfiguration` cmdlet deletes existing in [New-CsHealthMonitoringConfiguration](New-CsHealthMonitoringConfiguration.md) [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md index bbd7a131c7..ce701e607c 100644 --- a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsHostedVoicemailPolicy schema: 2.0.0 @@ -165,4 +165,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voic [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsHostingProvider.md b/skype/skype-ps/skype/Remove-CsHostingProvider.md index 307afddd32..8dd1e03560 100644 --- a/skype/skype-ps/skype/Remove-CsHostingProvider.md +++ b/skype/skype-ps/skype/Remove-CsHostingProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsHostingProvider schema: 2.0.0 @@ -199,4 +199,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsHostingProvider](New-CsHostingProvider.md) [Set-CsHostingProvider](Set-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsHuntGroup.md b/skype/skype-ps/skype/Remove-CsHuntGroup.md deleted file mode 100644 index 0bc4ff8868..0000000000 --- a/skype/skype-ps/skype/Remove-CsHuntGroup.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cshuntgroup -applicable: Skype for Business Online -title: Remove-CsHuntGroup -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Remove-CsHuntGroup - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Remove-CsCallQueue](Remove-CsCallQueue.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md index 5f1d0f13d4..947839dc20 100644 --- a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsHybridApplicationEndpoint schema: 2.0.0 @@ -101,8 +101,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) +[New-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps) -[Get-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) +[Get-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint?view=skype-ps) -[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) +[Set-CsHybridApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md b/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md index 9a97b1c9df..57891ebc8e 100644 --- a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cshybridpstnsite +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridpstnsite applicable: Skype for Business Online title: Remove-CsHybridPSTNSite schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsHybridPSTNSite @@ -156,4 +156,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsImConfiguration.md b/skype/skype-ps/skype/Remove-CsImConfiguration.md index a0dc98074b..9b6ba26e08 100644 --- a/skype/skype-ps/skype/Remove-CsImConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsImConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csimconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsImConfiguration schema: 2.0.0 @@ -130,8 +130,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) +[Get-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration?view=skype-ps) -[New-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) +[New-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration?view=skype-ps) -[Set-CsImConfiguration](https://docs.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) +[Set-CsImConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md b/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md index 067d6023b5..25c342bb06 100644 --- a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csimfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsImFilterConfiguration schema: 2.0.0 @@ -145,4 +145,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFil [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md b/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md index 197a41b16f..f3d59ef6ed 100644 --- a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csimtranslationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsImTranslationConfiguration schema: 2.0.0 @@ -111,4 +111,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md index b289a22865..acd10f5224 100644 --- a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skype/remove-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsKerberosAccountAssignment schema: 2.0.0 @@ -159,4 +159,3 @@ Instead, the cmdlet deletes existing instances of the Microsoft.Rtc.Management.W [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisLocation.md b/skype/skype-ps/skype/Remove-CsLisLocation.md index 043fae055b..ccca42e1b3 100644 --- a/skype/skype-ps/skype/Remove-CsLisLocation.md +++ b/skype/skype-ps/skype/Remove-CsLisLocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cslislocation +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLisLocation schema: 2.0.0 @@ -493,4 +493,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Remove-CsLisWirelessAccessPoint](Remove-CsLisWirelessAccessPoint.md) [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisPort.md b/skype/skype-ps/skype/Remove-CsLisPort.md index 766576e96e..6a06ce9cb4 100644 --- a/skype/skype-ps/skype/Remove-CsLisPort.md +++ b/skype/skype-ps/skype/Remove-CsLisPort.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cslisport +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLisPort schema: 2.0.0 @@ -183,4 +183,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Remove-CsLisLocation](Remove-CsLisLocation.md) [Remove-CsLisSwitch](Remove-CsLisSwitch.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md b/skype/skype-ps/skype/Remove-CsLisServiceProvider.md index 4809dd6244..e7c73e5c72 100644 --- a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md +++ b/skype/skype-ps/skype/Remove-CsLisServiceProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cslisserviceprovider +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLisServiceProvider schema: 2.0.0 @@ -95,4 +95,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Set-CsLisServiceProvider](Set-CsLisServiceProvider.md) [Get-CsLisServiceProvider](Get-CsLisServiceProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisSubnet.md b/skype/skype-ps/skype/Remove-CsLisSubnet.md index 6ad3321a5b..3ce56e33d1 100644 --- a/skype/skype-ps/skype/Remove-CsLisSubnet.md +++ b/skype/skype-ps/skype/Remove-CsLisSubnet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cslissubnet +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLisSubnet schema: 2.0.0 @@ -136,4 +136,3 @@ This cmdlet removes an object of type System.Management.Automation.PSCustomObjec [Get-CsLisSubnet](Get-CsLisSubnet.md) [Remove-CsLisLocation](Remove-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisSwitch.md b/skype/skype-ps/skype/Remove-CsLisSwitch.md index 76f3f6ebda..5ef8122f1d 100644 --- a/skype/skype-ps/skype/Remove-CsLisSwitch.md +++ b/skype/skype-ps/skype/Remove-CsLisSwitch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cslisswitch +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLisSwitch schema: 2.0.0 @@ -141,4 +141,3 @@ It removes an object of type System.Management.Automation.PSCustomObject. [Remove-CsLisLocation](Remove-CsLisLocation.md) [Get-CsLisPort](Get-CsLisPort.md) - diff --git a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md b/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md index e987410b6b..044104f835 100644 --- a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/skype/remove-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLisWirelessAccessPoint schema: 2.0.0 @@ -132,4 +132,3 @@ This cmdlet removes an object of type System.Management.Automation.PSCustomObjec [Get-CsLisWirelessAccessPoint](Get-CsLisWirelessAccessPoint.md) [Remove-CsLisLocation](Remove-CsLisLocation.md) - diff --git a/skype/skype-ps/skype/Remove-CsLocationPolicy.md b/skype/skype-ps/skype/Remove-CsLocationPolicy.md index 1f30767b50..b6aa1cf457 100644 --- a/skype/skype-ps/skype/Remove-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Remove-CsLocationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsLocationPolicy schema: 2.0.0 @@ -181,4 +181,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) [Test-CsLocationPolicy](Test-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsManagementConnection.md b/skype/skype-ps/skype/Remove-CsManagementConnection.md index 3fa999ecd5..6df3c26265 100644 --- a/skype/skype-ps/skype/Remove-CsManagementConnection.md +++ b/skype/skype-ps/skype/Remove-CsManagementConnection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csmanagementconnection +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsManagementConnection schema: 2.0.0 @@ -107,4 +107,3 @@ Instead, the `Remove-CsManagementConnection` cmdlet deletes instances of the Mic [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) [Set-CsManagementConnection](Set-CsManagementConnection.md) - diff --git a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md b/skype/skype-ps/skype/Remove-CsMcxConfiguration.md index 15f251a2cc..87060d1bca 100644 --- a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsMcxConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csmcxconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsMcxConfiguration schema: 2.0.0 manager: rogupta @@ -185,4 +185,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableC ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md b/skype/skype-ps/skype/Remove-CsMediaConfiguration.md index c80ffb002d..afa18b9584 100644 --- a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsMediaConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csmediaconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsMediaConfiguration schema: 2.0.0 @@ -154,4 +154,3 @@ Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md b/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md index 6475e2152a..29096e1294 100644 --- a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsMeetingConfiguration schema: 2.0.0 @@ -190,4 +190,3 @@ Instead, the `Remove-CsMeetingConfiguration` cmdlet deletes existing instances o [New-CsMeetingConfiguration](New-CsMeetingConfiguration.md) [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md b/skype/skype-ps/skype/Remove-CsMobilityPolicy.md index 1b202e5672..bf1e210f0e 100644 --- a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md +++ b/skype/skype-ps/skype/Remove-CsMobilityPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csmobilitypolicy -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmobilitypolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsMobilityPolicy schema: 2.0.0 manager: bulenteg @@ -216,4 +216,3 @@ Instead, the `Remove-CsMobilityPolicy` cmdlet deletes instances of the Microsoft ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md index f5dbe3debe..134bd4667f 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworkbandwidthpolicyprofile +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkBandwidthPolicyProfile schema: 2.0.0 @@ -153,4 +153,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md b/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md index 616d874b90..ae7068d77e 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkConfiguration schema: 2.0.0 @@ -142,4 +142,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md b/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md index c630fe8b40..3df20e1a1b 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworkinterregionroute +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkInterRegionRoute schema: 2.0.0 @@ -146,4 +146,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md b/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md index 72a1969f6f..8dc5aaec89 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworkintersitepolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkInterSitePolicy schema: 2.0.0 @@ -141,4 +141,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegion.md b/skype/skype-ps/skype/Remove-CsNetworkRegion.md index 3fbc38039e..3f35e18280 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegion.md +++ b/skype/skype-ps/skype/Remove-CsNetworkRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworkregion +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkRegion schema: 2.0.0 @@ -173,4 +173,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkRegion](Set-CsNetworkRegion.md) [Get-CsNetworkRegion](Get-CsNetworkRegion.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md b/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md index 5e6c326dec..57fec11fcc 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md +++ b/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworkregionlink +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkRegionLink schema: 2.0.0 @@ -143,4 +143,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkRegionLink](Set-CsNetworkRegionLink.md) [Get-CsNetworkRegionLink](Get-CsNetworkRegionLink.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkSite.md b/skype/skype-ps/skype/Remove-CsNetworkSite.md index cd132e027e..385a4f9411 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSite.md +++ b/skype/skype-ps/skype/Remove-CsNetworkSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworksite +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkSite schema: 2.0.0 @@ -141,4 +141,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkSite](Set-CsNetworkSite.md) [Get-CsNetworkSite](Get-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md b/skype/skype-ps/skype/Remove-CsNetworkSubnet.md index b7caa97b9b..60a89146b9 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md +++ b/skype/skype-ps/skype/Remove-CsNetworkSubnet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csnetworksubnet +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsNetworkSubnet schema: 2.0.0 @@ -143,4 +143,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Ne [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) - diff --git a/skype/skype-ps/skype/Remove-CsOAuthServer.md b/skype/skype-ps/skype/Remove-CsOAuthServer.md index 184efd5e08..8841ad2fa5 100644 --- a/skype/skype-ps/skype/Remove-CsOAuthServer.md +++ b/skype/skype-ps/skype/Remove-CsOAuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csoauthserver +online version: https://learn.microsoft.com/powershell/module/skype/remove-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsOAuthServer schema: 2.0.0 @@ -174,4 +174,3 @@ Instead, the `Remove-CsOAuthServer` cmdlet deletes existing instances of the Mic [New-CsOAuthServer](New-CsOAuthServer.md) [Set-CsOAuthServer](Set-CsOAuthServer.md) - diff --git a/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md deleted file mode 100644 index b208978fe7..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint -applicable: Skype for Business Online -title: Remove-CsOnlineApplicationEndpoint -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Remove-CsOnlineApplicationEndpoint - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. This cmdlet will be removed in the near future. - -The `Remove-CsOnlineApplicationEndpoint` is used to remove a Trusted Application Endpoint for a tenant. - -## SYNTAX - -``` -Remove-CsOnlineApplicationEndpoint [-Uri] [-Audience ] [-Ring ] - [-PhoneNumber ] [-IsInternalRun ] [-Tenant ] - [-RunFullProvisioningFlow ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This cmdlet is used to remove a Trusted Application Endpoint for a tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsOnlineApplicationEndpoint -Uri "sip:sample@domain.com" -``` - -This exampes removes the "sample@domain.com" application endpoint. - -## PARAMETERS - -### -Uri -Sip Uri that identifies the tenant specific endpoint for the application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The service number assigned to the trusted application endpoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -[Set-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/set-csonlineapplicationendpoint) - -[New-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint) - -[Get-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://docs.microsoft.com/skype-sdk/trusted-application-api/docs/trustedapplicationendpoint) diff --git a/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md deleted file mode 100644 index 411805ca4e..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinenumberportinorder -applicable: Skype for Business Online -title: Remove-CsOnlineNumberPortInOrder -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Remove-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -Remove-CsOnlineNumberPortInOrder [-Tenant ] -PortInOrderId [-DomainController ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -PortInOrderId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Remove-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Remove-CsOrganizationalAutoAttendant.md deleted file mode 100644 index 5795c85f9d..0000000000 --- a/skype/skype-ps/skype/Remove-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csorganizationalautoattendant -applicable: Skype for Business Online -title: Remove-CsOrganizationalAutoAttendant -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Remove-CsOrganizationalAutoAttendant - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md index fceb1df1d5..340683cf93 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsOutboundCallingNumberTranslationRule schema: 2.0.0 @@ -162,4 +162,3 @@ Instead, the `Remove-CsOutboundCallingNumberTranslationRule` cmdlet deletes exis [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md b/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md index 34c2aeb2c9..4ead086ae1 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsOutboundTranslationRule schema: 2.0.0 @@ -147,4 +147,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Tr [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsPartnerApplication.md b/skype/skype-ps/skype/Remove-CsPartnerApplication.md index 270f406696..1095f08f13 100644 --- a/skype/skype-ps/skype/Remove-CsPartnerApplication.md +++ b/skype/skype-ps/skype/Remove-CsPartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPartnerApplication schema: 2.0.0 @@ -186,4 +186,3 @@ Instead, the `Remove-CsPartnerApplication` cmdlet deletes existing instances of [New-CsPartnerApplication](New-CsPartnerApplication.md) [Set-CsPartnerApplication](Set-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md b/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md index 6522701a5a..40d9000d06 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchataddin +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatAddin schema: 2.0.0 manager: rogupta @@ -175,4 +175,3 @@ Instead, the `Remove-CsPersistentChatAddin` cmdlet deletes existing instances of [New-CsPersistentChatAddin](New-CsPersistentChatAddin.md) [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md b/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md index aca860ec19..658c5fe6a8 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcategory +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatCategory schema: 2.0.0 manager: rogupta @@ -164,4 +164,3 @@ Instead, the `Remove-CsPersistentChatCategory` cmdlet deletes existing instances [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md index fec07c8a29..cfca03a5d7 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcomplianceconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2015 title: Remove-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta @@ -172,4 +172,3 @@ Instead, the `Remove-CsPersistentChatComplianceConfiguration` cmdlet deletes exi [New-CsPersistentChatComplianceConfiguration](New-CsPersistentChatComplianceConfiguration.md) [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md index e8824c6b2f..9ad34a8583 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta @@ -172,4 +172,3 @@ Instead, the `Remove-CsPersistentChatConfiguration` cmdlet deletes existing inst [New-CsPersistentChatConfiguration](New-CsPersistentChatConfiguration.md) [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md index 18f661deb8..7443eaddef 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatendpoint +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatendpoint applicable: Lync Server 2013, Skype for Business Server 2015 title: Remove-CsPersistentChatEndpoint schema: 2.0.0 @@ -162,4 +162,3 @@ The `Remove-CsPersistentChatEndpoint` cmdlet does not return objects or data. [Get-CsPersistentChatEndpoint](Get-CsPersistentChatEndpoint.md) [New-CsPersistentChatEndpoint](New-CsPersistentChatEndpoint.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md b/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md index 95b702a137..dd1b9a62b1 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatmessage -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatmessage +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatMessage schema: 2.0.0 manager: rogupta @@ -290,4 +290,3 @@ None. ## RELATED LINKS [Clear-CsPersistentChatRoom](Clear-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md index 062d09557f..75517edccd 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015 title: Remove-CsPersistentChatPolicy schema: 2.0.0 @@ -198,4 +198,3 @@ Instead, the `Remove-CsPersistentChatPolicy` cmdlet deletes existing instances o [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md b/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md index 65af4207b1..d789e263f1 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatRoom schema: 2.0.0 manager: rogupta @@ -184,4 +184,3 @@ Instead, the `Remove-CsPersistentChatRoom` cmdlet deletes existing instances of [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Remove-CsPinPolicy.md b/skype/skype-ps/skype/Remove-CsPinPolicy.md index 073b588aac..b50a7851b2 100644 --- a/skype/skype-ps/skype/Remove-CsPinPolicy.md +++ b/skype/skype-ps/skype/Remove-CsPinPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPinPolicy schema: 2.0.0 @@ -215,4 +215,3 @@ Instead, the cmdlet removes one or more instances of the Microsoft.Rtc.Managemen [New-CsPinPolicy](New-CsPinPolicy.md) [Set-CsPinPolicy](Set-CsPinPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md index 21b2ff06e5..a4f1d6ea41 100644 --- a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPlatformServiceSettings schema: 2.0.0 manager: rogupta @@ -118,8 +118,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) -[Set-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) +[Set-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsPresencePolicy.md b/skype/skype-ps/skype/Remove-CsPresencePolicy.md index 6d886c1bde..7257c10c6d 100644 --- a/skype/skype-ps/skype/Remove-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Remove-CsPresencePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPresencePolicy schema: 2.0.0 @@ -204,4 +204,3 @@ Instead, the `Remove-CsPresencePolicy` cmdlet deletes instances of the Microsoft [New-CsPresencePolicy](New-CsPresencePolicy.md) [Set-CsPresencePolicy](Set-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsPresenceProvider.md b/skype/skype-ps/skype/Remove-CsPresenceProvider.md index fb31290fec..66ad10e6b7 100644 --- a/skype/skype-ps/skype/Remove-CsPresenceProvider.md +++ b/skype/skype-ps/skype/Remove-CsPresenceProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPresenceProvider schema: 2.0.0 @@ -164,4 +164,3 @@ Instead, the `Remove-CsPresenceProvider` cmdlet deletes instances of the Microso [New-CsPresenceProvider](New-CsPresenceProvider.md) [Set-CsPresenceProvider](Set-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md index 30c2a9d2ea..f0a1d07838 100644 --- a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csprivacyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPrivacyConfiguration schema: 2.0.0 @@ -203,4 +203,3 @@ Instead, the `Remove-CsPrivacyConfiguration` cmdlet deletes existing instances o [New-CsPrivacyConfiguration](New-CsPrivacyConfiguration.md) [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md b/skype/skype-ps/skype/Remove-CsProxyConfiguration.md index 5b406de0a9..fdf06b7833 100644 --- a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsProxyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsProxyConfiguration schema: 2.0.0 @@ -168,4 +168,3 @@ Instead, the `Remove-CsProxyConfiguration` cmdlet deletes existing instances of [New-CsProxyConfiguration](New-CsProxyConfiguration.md) [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsPublicProvider.md b/skype/skype-ps/skype/Remove-CsPublicProvider.md index 441097419b..85a18e6544 100644 --- a/skype/skype-ps/skype/Remove-CsPublicProvider.md +++ b/skype/skype-ps/skype/Remove-CsPublicProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPublicProvider schema: 2.0.0 @@ -170,4 +170,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsPublicProvider](New-CsPublicProvider.md) [Set-CsPublicProvider](Set-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md index a22ef311d6..75b54cd946 100644 --- a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPushNotificationConfiguration schema: 2.0.0 manager: rogupta @@ -197,8 +197,8 @@ Instead, the `Remove-CsPushNotificationConfiguration` cmdlet deletes instances o ## NOTES ## RELATED LINKS -[Set-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) +[Set-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration?view=skype-ps) -[New-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) +[New-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration?view=skype-ps) -[Get-CsPushNotificationConfiguration](https://docs.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) +[Get-CsPushNotificationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md b/skype/skype-ps/skype/Remove-CsQoEConfiguration.md index 0016b3be63..02136f6354 100644 --- a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsQoEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsQoEConfiguration schema: 2.0.0 @@ -154,4 +154,3 @@ Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Set [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md b/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md index c79b398607..698ba81e59 100644 --- a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRegistrarConfiguration schema: 2.0.0 @@ -175,4 +175,3 @@ Instead, the `Remove-CsRegistrarConfiguration` cmdlet deletes existing instances [New-CsRegistrarConfiguration](New-CsRegistrarConfiguration.md) [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md b/skype/skype-ps/skype/Remove-CsReportingConfiguration.md index 60ef8bb506..f39a678c24 100644 --- a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsReportingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsReportingConfiguration schema: 2.0.0 @@ -55,9 +55,12 @@ This collection is then piped to the `Remove-CsReportingConfiguration` cmdlet, w Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -eq "https://atl-sql-002.litwareinc.com/lync_reports" | Remove-CsReportingConfiguration ``` -The command shown in Example 3 deletes any reporting configuration settings where the reporting URL is set to https://atl-sql-002.litwareinc.com/lync_reports. +The command shown in Example 3 deletes any reporting configuration settings where the reporting URL is set to `https://atl-sql-002.litwareinc.com/lync_reports`. + To carry out this task, the command first uses the `Get-CsReportingConfiguration` cmdlet to return all the reporting configuration settings currently in use. -This collection is then piped to the `Where-Object` cmdlet, which selects only those settings where the ReportingURL property is equal to https://atl-sql-002.litwareinc.com/lync_reports. + +This collection is then piped to the `Where-Object` cmdlet, which selects only those settings where the ReportingURL property is equal to `https://atl-sql-002.litwareinc.com/lync_reports`. + That filtered collection is then piped to the `Remove-CsReportingConfiguration` cmdlet, which removes each item in the collection. @@ -153,4 +156,3 @@ Instead, the `Remove-CsReportingConfiguration` cmdlet deletes existing instances [New-CsReportingConfiguration](New-CsReportingConfiguration.md) [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md b/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md index 22be51ab23..7062f37fd4 100644 --- a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRgsAgentGroup schema: 2.0.0 @@ -173,4 +173,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. [New-CsRgsAgentGroup](New-CsRgsAgentGroup.md) [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md b/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md index b0dd17a42e..65b20debef 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRgsHolidaySet schema: 2.0.0 @@ -194,4 +194,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md index fe45d3ac03..d9620b6ae4 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRgsHoursOfBusiness schema: 2.0.0 @@ -191,4 +191,3 @@ Deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings. [New-CsRgsHoursOfBusiness](New-CsRgsHoursOfBusiness.md) [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsQueue.md b/skype/skype-ps/skype/Remove-CsRgsQueue.md index 72552f0ac2..a930605625 100644 --- a/skype/skype-ps/skype/Remove-CsRgsQueue.md +++ b/skype/skype-ps/skype/Remove-CsRgsQueue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRgsQueue schema: 2.0.0 @@ -177,4 +177,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. [New-CsRgsQueue](New-CsRgsQueue.md) [Set-CsRgsQueue](Set-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md b/skype/skype-ps/skype/Remove-CsRgsWorkflow.md index b885613184..e12c40c092 100644 --- a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/Remove-CsRgsWorkflow.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRgsWorkflow schema: 2.0.0 @@ -189,4 +189,3 @@ Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. [New-CsRgsWorkflow](New-CsRgsWorkflow.md) [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md b/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md index ac8f69f043..ad76c4dab3 100644 --- a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsRoutingConfiguration schema: 2.0.0 @@ -137,4 +137,3 @@ This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.Policy.V [Remove-CsVoiceRoute](Remove-CsVoiceRoute.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Remove-CsServerApplication.md b/skype/skype-ps/skype/Remove-CsServerApplication.md index 32b0b43703..a83b20565e 100644 --- a/skype/skype-ps/skype/Remove-CsServerApplication.md +++ b/skype/skype-ps/skype/Remove-CsServerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skype/remove-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsServerApplication schema: 2.0.0 @@ -155,4 +155,3 @@ The `Remove-CsServerApplication` cmdlet deletes existing instances of the Micros [New-CsServerApplication](New-CsServerApplication.md) [Set-CsServerApplication](Set-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md index a8d24d0a58..4d7b1655df 100644 --- a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSimpleUrlConfiguration schema: 2.0.0 @@ -28,12 +28,12 @@ Remove-CsSimpleUrlConfiguration [-Identity] [-Force] [-WhatIf] [-C ## DESCRIPTION In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -203,4 +203,3 @@ None. [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsSipDomain.md b/skype/skype-ps/skype/Remove-CsSipDomain.md index 01181219cf..d59dc449bb 100644 --- a/skype/skype-ps/skype/Remove-CsSipDomain.md +++ b/skype/skype-ps/skype/Remove-CsSipDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSipDomain schema: 2.0.0 @@ -157,4 +157,3 @@ Instead, the `Remove-CsSipDomain` cmdlet deletes existing instance of the Micros [New-CsSipDomain](New-CsSipDomain.md) [Set-CsSipDomain](Set-CsSipDomain.md) - diff --git a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md index 9cf05c6684..6dcccff10c 100644 --- a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSipResponseCodeTranslationRule schema: 2.0.0 @@ -170,4 +170,3 @@ Instead, the cmdlet deletes modifies instances of the Microsoft.Rtc.Management.W [New-CsSipResponseCodeTranslationRule](New-CsSipResponseCodeTranslationRule.md) [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md b/skype/skype-ps/skype/Remove-CsSlaConfiguration.md index 5c8a7161c1..9cf8fa98a8 100644 --- a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsSlaConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csslaconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSlaConfiguration schema: 2.0.0 manager: rogupta @@ -118,6 +118,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://docs.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) -[Set-CsSlaConfiguration](https://docs.microsoft.com/powershell/module/skype/set-csslaconfiguration?view=skype-ps) +[Set-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsSlaDelegates.md b/skype/skype-ps/skype/Remove-CsSlaDelegates.md index 8c60037f3b..66462078dc 100644 --- a/skype/skype-ps/skype/Remove-CsSlaDelegates.md +++ b/skype/skype-ps/skype/Remove-CsSlaDelegates.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cssladelegates -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssladelegates +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSlaDelegates schema: 2.0.0 manager: rogupta @@ -141,4 +141,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Add-CsSlaDelegates](https://docs.microsoft.com/powershell/module/skype/add-cssladelegates?view=skype-ps) +[Add-CsSlaDelegates](https://learn.microsoft.com/powershell/module/skype/add-cssladelegates?view=skype-ps) diff --git a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md index 00f32cb3b0..7c0a317d02 100644 --- a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsStaticRoutingConfiguration schema: 2.0.0 @@ -176,4 +176,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md index 368378bbc1..47b61a9369 100644 --- a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsStorageServiceConfiguration schema: 2.0.0 @@ -159,4 +159,3 @@ The `Remove-CsStorageServiceConfiguration` cmdlet does not return any objects or [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md index 519a6c5f48..f8d9052ec0 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md @@ -1,8 +1,8 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsupgradepolicy -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamsupgradepolicy +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTeamsUpgradePolicy schema: 2.0.0 manager: rogupta @@ -69,7 +69,7 @@ Accept wildcard characters: False ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) diff --git a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md b/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md index dbb68757a7..ce9b3db03d 100644 --- a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTelemetryConfiguration schema: 2.0.0 @@ -141,4 +141,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md index 6948145cf8..0927a0240a 100644 --- a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstenantupdatetimewindow applicable: Skype for Business Online title: Remove-CsTenantUpdateTimeWindow schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTenantUpdateTimeWindow @@ -136,4 +136,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTestDevice.md b/skype/skype-ps/skype/Remove-CsTestDevice.md index ab03c9f688..0cf245979f 100644 --- a/skype/skype-ps/skype/Remove-CsTestDevice.md +++ b/skype/skype-ps/skype/Remove-CsTestDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTestDevice schema: 2.0.0 @@ -187,4 +187,3 @@ Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableCo [New-CsTestDevice](New-CsTestDevice.md) [Set-CsTestDevice](Set-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/Remove-CsTestUserCredential.md b/skype/skype-ps/skype/Remove-CsTestUserCredential.md index d693a37093..2d8afa8192 100644 --- a/skype/skype-ps/skype/Remove-CsTestUserCredential.md +++ b/skype/skype-ps/skype/Remove-CsTestUserCredential.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstestusercredential +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTestUserCredential schema: 2.0.0 @@ -160,4 +160,3 @@ Instead, the `Remove-CsTestUserCredential` cmdlet deletes existing instances of [Get-CsTestUserCredential](Get-CsTestUserCredential.md) [Set-CsTestUserCredential](Set-CsTestUserCredential.md) - diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md index 3eb14024f2..a55a5ee89b 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsThirdPartyVideoSystem schema: 2.0.0 @@ -137,4 +137,3 @@ The `Remove-CsThirdPartyVideoSystem` cmdlet does not return any objects or data. [New-CsThirdPartyVideoSystem](New-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md index c2f8e8eefd..e2e7dcdc56 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsThirdPartyVideoSystemPolicy schema: 2.0.0 @@ -205,4 +205,3 @@ Instead, the `Remove-CsThirdPartyVideoSystemPolicy` cmdlet deletes instances of [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md b/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md index 1016d4eea7..4c863ae2fc 100644 --- a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTrunkConfiguration schema: 2.0.0 @@ -144,4 +144,3 @@ It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Tr [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplication.md b/skype/skype-ps/skype/Remove-CsTrustedApplication.md index 1bcb770b4b..f740667361 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplication.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTrustedApplication schema: 2.0.0 @@ -150,4 +150,3 @@ It removes an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplicat [Set-CsTrustedApplication](Set-CsTrustedApplication.md) [Get-CsTrustedApplication](Get-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md b/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md index 1c1c17f968..b98867daaa 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstrustedapplicationcomputer +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTrustedApplicationComputer schema: 2.0.0 @@ -149,4 +149,3 @@ It removes an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. [Remove-CsTrustedApplicationPool](Remove-CsTrustedApplicationPool.md) [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md index 689e989bfc..e90e6d3555 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTrustedApplicationEndpoint schema: 2.0.0 @@ -125,4 +125,3 @@ It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADAppl [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md b/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md index 19ca3967d8..1d488c17fc 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTrustedApplicationPool schema: 2.0.0 @@ -149,4 +149,3 @@ It removes an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. [Set-CsTrustedApplicationPool](Set-CsTrustedApplicationPool.md) [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) - diff --git a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md index 39442d4fb6..f45cd01e67 100644 --- a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csucphoneconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/remove-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsUCPhoneConfiguration schema: 2.0.0 @@ -188,4 +188,3 @@ Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableCo [New-CsUCPhoneConfiguration](New-CsUCPhoneConfiguration.md) [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md b/skype/skype-ps/skype/Remove-CsUnassignedNumber.md index e06fba8054..76c0291f9f 100644 --- a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/Remove-CsUnassignedNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skype/remove-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsUnassignedNumber schema: 2.0.0 @@ -145,4 +145,3 @@ It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnou [Get-CsAnnouncement](Get-CsAnnouncement.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Remove-CsUserAcp.md b/skype/skype-ps/skype/Remove-CsUserAcp.md index 121383ecbf..dc022a2e7e 100644 --- a/skype/skype-ps/skype/Remove-CsUserAcp.md +++ b/skype/skype-ps/skype/Remove-CsUserAcp.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csuseracp -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuseracp +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsUserAcp schema: 2.0.0 manager: bulenteg @@ -25,7 +25,7 @@ Remove-CsUserAcp [-Identity] [-Name ] [-TollNumber ] -RegionalGroup - -CountryOrRegion -Area -CapitalOrMajorCity -Quantity - [-TelephoneNumber ] [-AreaCode ] -InventoryType [-DomainController ] [-Force] - [] -``` - -## DESCRIPTION -Acquiring tenant telephone numbers is a two step process. - -+12127539059 +1 (212) 753 9059 - -`Select-CsOnlineTelephoneNumberInventory -ReservationId 76ce711f-9da4-46d9-b81d-471172450443 -TelephoneNumbers 12127539058,12127539059 -Region NOAM -Country US -Area NY -City NY` - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Search-CsOnlineTelephoneNumberInventory -InventoryType Service -Region NOAM -Country US -Area NY -City NY -Quantity 10 -``` - -This example reserves 10 Service type telephone numbers in New York, New York. - - -## PARAMETERS - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -Specifies the target geographical city for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: City -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InventoryType -Specifies the target telephone number type for the cmdlet. -Acceptable values are: - -"Service" for numbers assigned to conferencing support. - -"Subscriber" for numbers supporting public switched telephone network (PSTN) functions. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Quantity -Specifies the quantity of telephone numbers to reserve. -The maximum value is 500. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AreaCode -Specifies the area code to search for telephone numbers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -Specifies either an individual telephone number to reserve, or multiple telephone numbers can be entered separated by a comma. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies your tenant identifier. -To find your tenant id use the command: `Get-CsTenant | fl objectid`. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### -This cmdlets returns an Microsoft.Rtc.Management.Hosted.Bvd.Types.NumberReservationResponse object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md b/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md deleted file mode 100644 index e52216724d..0000000000 --- a/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/select-csonlinetelephonenumberinventory -applicable: Skype for Business Online -title: Select-CsOnlineTelephoneNumberInventory -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Select-CsOnlineTelephoneNumberInventory - -## SYNOPSIS -Use the `Select-CsOnlineTelephoneNumberInventory` cmdlet to acquire a list of inventoried telephone numbers and associate them with a Business Voice Directory tenant. -The input must be from a telephone number search operation generated by the `Search-CsOnlineTelephoneNumberInventory` cmdlet. - -**Note**: - -As of April 30, 2022, the existing Skype for Business PowerShell cmdlets for telephone number search and related activities will be deprecated and will no longer be available for use. The new Teams PowerShell cmdlets for telephone number search and related activities are already available. For more details, see [New-CsOnlineTelephoneNumberOrder](https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Select-CsOnlineTelephoneNumberInventory [-Tenant ] -RegionalGroup - -CountryOrRegion -Area -CapitalOrMajorCity -ReservationId - -TelephoneNumbers [-LocationId ] [-DomainController ] [-Force] - [] -``` - -## DESCRIPTION -Acquiring tenant telephone numbers is a two step process. - -+12127539059 +1 (212) 753 9059 - -`Select-CsOnlineTelephoneNumberInventory -ReservationId 76ce711f-9da4-46d9-b81d-471172450443 -TelephoneNumbers 12127539058,12127539059 -RegionalGroup NOAM -CountryOrRegion US -Area NY -CapitalOrMajorCity NY` - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Select-CsOnlineTelephoneNumberInventory -ReservationId 76ce711f-9da4-46d9-b81d-471172450443 -TelephoneNumbers 12127539058,12127539059 -RegionalGroup NOAM -CountryOrRegion US -Area NY -CapitalOrMajorCity NY -``` - -This example assigns two telephone numbers to New York City. - -## PARAMETERS - -### -Area -Specifies the target geographical area for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CapitalOrMajorCity -Specifies the target geographical city for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: City -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the target country for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Country -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegionalGroup -Specifies the target geographical region for the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Region -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservationId -Specifies the telephone number reservation to access. -The reservation itself is created by the `Search-CsOnlineTelephoneNumberInventory` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumbers -Specifies the telephone numbers you wish to assign, separated by commas. -The numbers must be in E.164 format. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationId -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### -This cmdlets returns an Microsoft.Rtc.Management.Hosted.Bvd.Types.NumberReservationResponse object. - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md b/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md index 1305c1f2c2..32085367bd 100644 --- a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csavedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAVEdgeConfiguration schema: 2.0.0 @@ -222,4 +222,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsAVEdgeConfiguration](New-CsAVEdgeConfiguration.md) [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md b/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md index 9ac552a311..a8885119cb 100644 --- a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csaccessedgeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csaccessedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAccessEdgeConfiguration schema: 2.0.0 @@ -659,4 +659,3 @@ The `Set-CsAccessEdgeConfiguration` cmdlet does not return any objects or values ## RELATED LINKS [Get-CsAccessEdgeConfiguration](Get-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md b/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md index c227ee9055..deb444e50b 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csaddressbookconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAddressBookConfiguration schema: 2.0.0 @@ -403,4 +403,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsAddressBookConfiguration](New-CsAddressBookConfiguration.md) [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md index 500c1b04bc..eb9e97ae29 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAddressBookNormalizationConfiguration schema: 2.0.0 @@ -220,4 +220,3 @@ Instead, the `Set-CsAddressBookNormalizationConfiguration` cmdlet modifies exist [Remove-CsAddressBookNormalizationConfiguration](Remove-CsAddressBookNormalizationConfiguration.md) [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) - diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md b/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md index 66b673c768..c68c1560bb 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationrule +online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAddressBookNormalizationRule schema: 2.0.0 @@ -239,4 +239,3 @@ Instead, the `Set-CsAddressBookNormalizationRule` cmdlet modifies existing insta [New-CsAddressBookNormalizationRule](New-CsAddressBookNormalizationRule.md) [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsAdminRole.md b/skype/skype-ps/skype/Set-CsAdminRole.md index dcd7aeca02..844768e6e6 100644 --- a/skype/skype-ps/skype/Set-CsAdminRole.md +++ b/skype/skype-ps/skype/Set-CsAdminRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csadminrole +online version: https://learn.microsoft.com/powershell/module/skype/set-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAdminRole schema: 2.0.0 @@ -335,4 +335,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsAllowedDomain.md b/skype/skype-ps/skype/Set-CsAllowedDomain.md index 9931f1c783..09d21b4f92 100644 --- a/skype/skype-ps/skype/Set-CsAllowedDomain.md +++ b/skype/skype-ps/skype/Set-CsAllowedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csalloweddomain +online version: https://learn.microsoft.com/powershell/module/skype/set-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAllowedDomain schema: 2.0.0 @@ -294,4 +294,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsAllowedDomain](Remove-CsAllowedDomain.md) [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAnalogDevice.md b/skype/skype-ps/skype/Set-CsAnalogDevice.md index 10fe2f56c8..5c9cadbf2c 100644 --- a/skype/skype-ps/skype/Set-CsAnalogDevice.md +++ b/skype/skype-ps/skype/Set-CsAnalogDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csanalogdevice +online version: https://learn.microsoft.com/powershell/module/skype/set-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAnalogDevice schema: 2.0.0 @@ -338,4 +338,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [New-CsAnalogDevice](New-CsAnalogDevice.md) [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) - diff --git a/skype/skype-ps/skype/Set-CsAnnouncement.md b/skype/skype-ps/skype/Set-CsAnnouncement.md index 0f84ce0f8e..7ed8e2878a 100644 --- a/skype/skype-ps/skype/Set-CsAnnouncement.md +++ b/skype/skype-ps/skype/Set-CsAnnouncement.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csannouncement +online version: https://learn.microsoft.com/powershell/module/skype/set-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAnnouncement schema: 2.0.0 @@ -289,4 +289,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsAnnouncement](Get-CsAnnouncement.md) [Import-CsAnnouncementFile](Import-CsAnnouncementFile.md) - diff --git a/skype/skype-ps/skype/Set-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Set-CsApplicationAccessPolicy.md deleted file mode 100644 index accadd1b64..0000000000 --- a/skype/skype-ps/skype/Set-CsApplicationAccessPolicy.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csapplicationaccesspolicy -applicable: Skype for Business Online -title: Set-CsApplicationAccessPolicy -schema: 2.0.0 -manager: zhengni -author: frankpeng7 -ms.author: frpeng -ms.reviewer: ---- - -# Set-CsApplicationAccessPolicy - -## SYNOPSIS - -Modifies an existing application access policy. - -## SYNTAX - -### Identity - -``` -Set-CsApplicationAccessPolicy [-Identity ] [-AppIds ] -``` - -## DESCRIPTION - -This cmdlet modifies an existing application access policy. - -## EXAMPLES - -### Add new app ID to the policy - -``` -PS C:\> Set-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds @{Add="5817674c-81d9-4adb-bfb2-8f6a442e4622"} -``` - -The command shown above adds a new app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" to the per-user application access policy ASimplePolicy. - -### Remove app IDs from the policy - -``` -PS C:\> Set-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds @{Remove="5817674c-81d9-4adb-bfb2-8f6a442e4622"} -``` - -The command shown above removes the app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" from the per-user application access policy ASimplePolicy. - -## PARAMETERS - -### -Identity - -Unique identifier assigned to the policy when it was created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppIds - -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) diff --git a/skype/skype-ps/skype/Set-CsApplicationServer.md b/skype/skype-ps/skype/Set-CsApplicationServer.md index 1de977f970..0d12488539 100644 --- a/skype/skype-ps/skype/Set-CsApplicationServer.md +++ b/skype/skype-ps/skype/Set-CsApplicationServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csapplicationserver +online version: https://learn.microsoft.com/powershell/module/skype/set-csapplicationserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsApplicationServer schema: 2.0.0 @@ -427,4 +427,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsServerApplication](Get-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md b/skype/skype-ps/skype/Set-CsArchivingConfiguration.md index 4c4793d251..f3a3c69100 100644 --- a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsArchivingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csarchivingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsArchivingConfiguration schema: 2.0.0 @@ -386,4 +386,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsArchivingConfiguration](Remove-CsArchivingConfiguration.md) [Set-CsArchivingServer](Set-CsArchivingServer.md) - diff --git a/skype/skype-ps/skype/Set-CsArchivingPolicy.md b/skype/skype-ps/skype/Set-CsArchivingPolicy.md index b9ff16153c..f4e73c3195 100644 --- a/skype/skype-ps/skype/Set-CsArchivingPolicy.md +++ b/skype/skype-ps/skype/Set-CsArchivingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csarchivingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsArchivingPolicy schema: 2.0.0 @@ -265,4 +265,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsArchivingPolicy](New-CsArchivingPolicy.md) [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsArchivingServer.md b/skype/skype-ps/skype/Set-CsArchivingServer.md index c921084fca..8d31fba3a6 100644 --- a/skype/skype-ps/skype/Set-CsArchivingServer.md +++ b/skype/skype-ps/skype/Set-CsArchivingServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csarchivingserver +online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsArchivingServer schema: 2.0.0 @@ -156,4 +156,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.Displ ## RELATED LINKS [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md b/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md index dba2489097..bb891a7b26 100644 --- a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csaudiotestserviceapplication +online version: https://learn.microsoft.com/powershell/module/skype/set-csaudiotestserviceapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAudioTestServiceApplication schema: 2.0.0 @@ -356,4 +356,3 @@ The `Set-CsAudioTestServiceApplication` cmdlet does not return any objects or va ## RELATED LINKS [Get-CsAudioTestServiceApplication](Get-CsAudioTestServiceApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsAuthConfig.md b/skype/skype-ps/skype/Set-CsAuthConfig.md index f4561db533..3e47cfbe63 100644 --- a/skype/skype-ps/skype/Set-CsAuthConfig.md +++ b/skype/skype-ps/skype/Set-CsAuthConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csauthconfig +online version: https://learn.microsoft.com/powershell/module/skype/set-csauthconfig applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAuthConfig schema: 2.0.0 @@ -138,6 +138,6 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## NOTES -After changing CsAuthConfig, you must run [Enable-CsComputer](https://docs.microsoft.com/powershell/module/skype/enable-cscomputer?view=skype-ps) on each Skype for Business Server machine before your changes take effect. +After changing CsAuthConfig, you must run [Enable-CsComputer](https://learn.microsoft.com/powershell/module/skype/enable-cscomputer?view=skype-ps) on each Skype for Business Server machine before your changes take effect. ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md index ba753c2868..19027a504c 100644 --- a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsAutodiscoverConfiguration schema: 2.0.0 manager: rogupta @@ -67,7 +67,7 @@ $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.co Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Add=$Link1} ``` -The commands shown in Example 1 add a new Autodiscover URL (https://LyncDiscover.fabrikam.com) to the Autodiscover configuration settings assigned to the Redmond site. +The commands shown in Example 1 add a new Autodiscover URL (`https://LyncDiscover.fabrikam.com`) to the Autodiscover configuration settings assigned to the Redmond site. To do this, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL; that URL is stored in a variable named $Link1. In the second command, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to add the new URL to any URLs already assigned to these settings. This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. @@ -99,8 +99,8 @@ Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks @{Replace=$Li ``` Example 3 shows how you can replace an existing collection of Autodiscover URLs with, in this case, a single URL. -To carry out this task, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL for https://LyncDiscover.contoso.com; the resulting URL is stored in a variable named $Link2. -The second command then uses the `Set-CsAutoDiscoverConfiguration` cmdlet and the WebLinks parameter to remove any URLs previously assigned to the Redmond site and replace them with the URL for https://LyncDiscover.contoso.com. +To carry out this task, the first command in the example uses the `New-CsWebLink` cmdlet to create a new Autodiscover URL for `https://LyncDiscover.contoso.com`; the resulting URL is stored in a variable named $Link2. +The second command then uses the `Set-CsAutoDiscoverConfiguration` cmdlet and the WebLinks parameter to remove any URLs previously assigned to the Redmond site and replace them with the URL for `https://LyncDiscover.contoso.com`. To do this, the command uses the Replace method instead of the Add or Remove method. diff --git a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md b/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md index 0172972f03..dec80abb43 100644 --- a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csbackupserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsBackupServiceConfiguration schema: 2.0.0 @@ -332,4 +332,3 @@ Instead, the `Set-CsBackupServiceConfiguration` cmdlet modifies existing instanc [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) [Remove-CsBackupServiceConfiguration](Remove-CsBackupServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md index 343498ee5f..cc5fd68c6b 100644 --- a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csbandwidthpolicyserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsBandwidthPolicyServiceConfiguration schema: 2.0.0 @@ -237,4 +237,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.B [Remove-CsBandwidthPolicyServiceConfiguration](Remove-CsBandwidthPolicyServiceConfiguration.md) [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsBlockedDomain.md b/skype/skype-ps/skype/Set-CsBlockedDomain.md index e440e9efdc..15662712d0 100644 --- a/skype/skype-ps/skype/Set-CsBlockedDomain.md +++ b/skype/skype-ps/skype/Set-CsBlockedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csblockeddomain +online version: https://learn.microsoft.com/powershell/module/skype/set-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsBlockedDomain schema: 2.0.0 @@ -207,4 +207,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsBlockedDomain](Remove-CsBlockedDomain.md) [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md index d191cf65a0..62a74c0304 100644 --- a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csbroadcastmeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csbroadcastmeetingconfiguration applicable: Skype for Business Online title: Set-CsBroadcastMeetingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsBroadcastMeetingConfiguration @@ -447,4 +447,3 @@ None ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsBusyOptions.md b/skype/skype-ps/skype/Set-CsBusyOptions.md index 7ab1f02455..5743b4b153 100644 --- a/skype/skype-ps/skype/Set-CsBusyOptions.md +++ b/skype/skype-ps/skype/Set-CsBusyOptions.md @@ -36,7 +36,7 @@ After configuration, the Busy Options setting is in effect for all the user's Sk Users will see missed-call notifications on their Skype for Business clients and devices, and they will be notified by email as well. Callers whose call was rejected due to Busy on Busy will see a notification in their Skype for Business client stating that the user they attempted to reach is busy on another call. -For more information about how to enable Busy Options in your organization, see (https://docs.microsoft.com/skypeforbusiness/deploy/deploy-enterprise-voice/install-and-configure-busy-options). +For more information about how to enable Busy Options in your organization, see (https://learn.microsoft.com/skypeforbusiness/deploy/deploy-enterprise-voice/install-and-configure-busy-options). ## EXAMPLES @@ -162,6 +162,6 @@ Microsoft.Rtc.Management.AD.UserIdParameter object. ## NOTES ## RELATED LINKS -[Get-CsBusyOptions](https://docs.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) +[Get-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions?view=skype-ps) -[Remove-CsBusyOptions](https://docs.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) +[Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsCallParkOrbit.md b/skype/skype-ps/skype/Set-CsCallParkOrbit.md index 03aae13268..1962bcc635 100644 --- a/skype/skype-ps/skype/Set-CsCallParkOrbit.md +++ b/skype/skype-ps/skype/Set-CsCallParkOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscallparkorbit +online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCallParkOrbit schema: 2.0.0 @@ -269,4 +269,3 @@ This cmdlet modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.Di [Remove-CsCallParkOrbit](Remove-CsCallParkOrbit.md) [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) - diff --git a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md b/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md index 8a1c8aa1fc..81af567605 100644 --- a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md +++ b/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscallparkservicemusiconholdfile +online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkservicemusiconholdfile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCallParkServiceMusicOnHoldFile schema: 2.0.0 @@ -45,17 +45,13 @@ Audio files must be in the following format: Windows Media Audio 9, 44 kHz, 16 b ### -------------------------- Example 1 -------------------------- ``` -$a = Get-Content -ReadCount 0 -Encoding byte "C:\MoHFiles\soothingmusic.wma" +$a = [System.IO.File]::ReadAllBytes('C:\MoHFiles\soothingmusic.wma') Set-CsCallParkServiceMusicOnHoldFile -Service ApplicationServer:pool0.litwareinc.com -Content $a ``` This example sets the file SoothingMusic.wma to be the audio file that is played to callers whose calls are parked. -The first line of this example is a call to the `Get-Content` cmdlet. -This cmdlet simply reads the contents of a file and assigns them, in this case, to the variable $a. -We pass a value of 0 to the ReadCount parameter so the `Get-Content` cmdlet will read the entire file at once (rather than try to read it line by line, which doesn't apply to an audio file). -We set the Encoding parameter to byte. -This tells the `Get-Content` cmdlet that the content we want to read into variable $a is a byte array rather than the audio file in .wma format. +The first line of this example uses the `[System.IO.File]::ReadAllBytes` command to read the contents of a file in byte format and assign them, in this case, to the variable $a. Line 2 in this example is where we actually assign the audio file. We call the `Set-CsCallParkServiceMusicOnHoldFile` cmdlet and specify the service ID where the Call Park service is running. @@ -84,8 +80,7 @@ Accept wildcard characters: False ### -Content The contents of the audio file in byte format. -Use the `Get-Content` cmdlet to retrieve the contents of the audio file in byte format. -(For details, see the Examples section in this topic.) +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[] @@ -173,4 +168,3 @@ This cmdlet does not return a value. [Set-CsCpsConfiguration](Set-CsCpsConfiguration.md) [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md deleted file mode 100644 index e3356d22e3..0000000000 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ /dev/null @@ -1,554 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscallqueue -applicable: Skype for Business Online -title: Set-CsCallQueue -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# Set-CsCallQueue - -## SYNOPSIS -Updates a Call Queue in your Skype for Business Online or Teams organization. - -## SYNTAX - -``` -Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [] -``` - -## DESCRIPTION - -Set-CsCallQueue cmdlet provides a way for you to modify the properties of an existing Call Queue; for example, you can change the name for the Call Queue, the distribution lists associated with the Call Queue, or the welcome audio file. - -The Set-CsCallQueue cmdlet may suggest additional steps required to complete the Call Queue setup. - -Note that this cmdlet is in the Skype for Business Online PowerShell module and also affects Teams. The reason the "Applies To:" is stated as Skype for Business Online is because it must match the actual module name of the cmdlet. To learn how this cmdlet is used with Skype for Business Online and Teams, see https://docs.microsoft.com/microsoftteams/create-a-phone-system-call-queue. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -UseDefaultMusicOnHold $true -``` - -This example updates the Call Queue with identity e7e00636-47da-449c-a36b-1b3d6ee04440 by making it use the default music on hold. - -### -------------------------- Example 2 -------------------------- -``` -Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldAudioFileId $audioFile.Id -``` - -This example updates the Call Queue with new distribution lists and references a new music on hold audio file using the audio file ID from the stored variable $audioFile created with the [Import-CsOnlineAudioFile cmdlet](https://docs.microsoft.com/powershell/module/skype/import-csonlineaudiofile) - -## PARAMETERS - -### -Identity -PARAMVALUE: Guid - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentAlertTime -The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 30 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOptOut -The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DistributionLists -The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldAudioFileId -The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 Call Queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OboResourceAccountIds -The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowAction -The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. - -PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: DisconnectWithBusy -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowActionTarget -The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this parameter is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowThreshold -The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 50 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoutingMethod -The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. - -PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Attendant -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutAction -The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. - -PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: Disconnect -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutActionTarget -The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutThreshold -The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. -The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. - -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: 1200 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefaultMusicOnHold -The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WelcomeMusicAudioFileId -The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PresenceBasedRouting -The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConferenceMode -The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: - -- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. - -- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LanguageId -The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. - -You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LineUri -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableOverflowSharedVoicemailTranscription -The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowSharedVoicemailTextToSpeechPrompt -The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverflowSharedVoicemailAudioFilePrompt -The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTimeoutSharedVoicemailTranscription -The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutSharedVoicemailTextToSpeechPrompt -The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeoutSharedVoicemailAudioFilePrompt -The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelId -Id of the channel to connect a call queue to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelUserObjectId -The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md b/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md index af6fc58a40..5177db6710 100644 --- a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscallviaworkpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCallViaWorkPolicy schema: 2.0.0 @@ -229,4 +229,3 @@ None. [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md index 5aa1b7f93d..4d556a212d 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscceapplianceconfigurationreplicationstatus +online version: https://learn.microsoft.com/powershell/module/skype/set-cscceapplianceconfigurationreplicationstatus applicable: Skype for Business Online title: Set-CsCceApplianceConfigurationReplicationStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsCceApplianceConfigurationReplicationStatus @@ -156,4 +156,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md index b274322ab8..1ca389b8ab 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscceappliancedeploymentstatus +online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancedeploymentstatus applicable: Skype for Business Online title: Set-CsCceApplianceDeploymentStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsCceApplianceDeploymentStatus @@ -220,4 +220,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceStatus.md index 590322faad..634a66015e 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscceappliancestatus +online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancestatus applicable: Skype for Business Online title: Set-CsCceApplianceStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsCceApplianceStatus @@ -202,4 +202,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsCdrConfiguration.md b/skype/skype-ps/skype/Set-CsCdrConfiguration.md index 1741e90be4..adac626963 100644 --- a/skype/skype-ps/skype/Set-CsCdrConfiguration.md +++ b/skype/skype-ps/skype/Set-CsCdrConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscdrconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCdrConfiguration schema: 2.0.0 @@ -310,4 +310,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsCdrConfiguration](New-CsCdrConfiguration.md) [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsCertificate.md b/skype/skype-ps/skype/Set-CsCertificate.md index ec3efc3634..a88a78863d 100644 --- a/skype/skype-ps/skype/Set-CsCertificate.md +++ b/skype/skype-ps/skype/Set-CsCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscertificate +online version: https://learn.microsoft.com/powershell/module/skype/set-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCertificate schema: 2.0.0 @@ -376,4 +376,3 @@ The `Set-CsCertificate` cmdlet does not return any values or objects. [Remove-CsCertificate](Remove-CsCertificate.md) [Request-CsCertificate](Request-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Set-CsClientPin.md b/skype/skype-ps/skype/Set-CsClientPin.md index 0aae41324c..186c380a81 100644 --- a/skype/skype-ps/skype/Set-CsClientPin.md +++ b/skype/skype-ps/skype/Set-CsClientPin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclientpin +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClientPin schema: 2.0.0 @@ -207,4 +207,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.UserPin [Lock-CsClientPin](Lock-CsClientPin.md) [Unlock-CsClientPin](Unlock-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Set-CsClientPolicy.md b/skype/skype-ps/skype/Set-CsClientPolicy.md index 25a81e08f1..6af1ef3225 100644 --- a/skype/skype-ps/skype/Set-CsClientPolicy.md +++ b/skype/skype-ps/skype/Set-CsClientPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclientpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClientPolicy schema: 2.0.0 manager: bulenteg @@ -1372,8 +1372,7 @@ To search only display name, first name, and last name you would construct this After the binary value has been constructed it must then be converted to a decimal value before being assigned to SearchPrefixFlags. To convert a binary number to a decimal number you can use the following Windows PowerShell command: -`\[Convert\]::ToInt32("1110111", 2)` - +`[Convert]::ToInt32("1110111", 2)` ```yaml Type: UInt16 @@ -2119,4 +2118,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsClientPolicy](New-CsClientPolicy.md) [Remove-CsClientPolicy](Remove-CsClientPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md b/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md index 729650a4e5..c7a71cdaca 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md +++ b/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclientversionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClientVersionConfiguration schema: 2.0.0 @@ -266,4 +266,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsClientVersionConfiguration](New-CsClientVersionConfiguration.md) [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md b/skype/skype-ps/skype/Set-CsClientVersionPolicy.md index 0a43f47feb..dfff66f31a 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md +++ b/skype/skype-ps/skype/Set-CsClientVersionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclientversionpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClientVersionPolicy schema: 2.0.0 @@ -252,4 +252,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md b/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md index 493fac5211..b9933740d1 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclientversionpolicyrule +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClientVersionPolicyRule schema: 2.0.0 @@ -485,4 +485,3 @@ Instead, the `Set-CsClientVersionPolicyRule` cmdlet modifies instances of the Mi [New-CsClientVersionPolicyRule](New-CsClientVersionPolicyRule.md) [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) - diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md b/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md index b3756ad646..d15bbdcaf8 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md +++ b/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscloudcalldataconnector +online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnector applicable: Skype for Business Server 2019 title: Set-CsCloudCallDataConnector schema: 2.0.0 diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md index 98dd2888e7..021a5cf3e8 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscloudcalldataconnectorconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 title: Set-CsCloudCallDataConnectorConfiguration schema: 2.0.0 diff --git a/skype/skype-ps/skype/Set-CsClsConfiguration.md b/skype/skype-ps/skype/Set-CsClsConfiguration.md index 9aaed6e428..ac2b5e0018 100644 --- a/skype/skype-ps/skype/Set-CsClsConfiguration.md +++ b/skype/skype-ps/skype/Set-CsClsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClsConfiguration schema: 2.0.0 @@ -620,4 +620,3 @@ Instead, the `Set-CsClsConfiguration` cmdlet modifies existing instances of the [New-CsClsConfiguration](New-CsClsConfiguration.md) [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsClsRegion.md b/skype/skype-ps/skype/Set-CsClsRegion.md index 1efa94ab40..89a4dee70b 100644 --- a/skype/skype-ps/skype/Set-CsClsRegion.md +++ b/skype/skype-ps/skype/Set-CsClsRegion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclsregion +online version: https://learn.microsoft.com/powershell/module/skype/set-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClsRegion schema: 2.0.0 @@ -213,4 +213,3 @@ Instead, the `Set-CsClsRegion` cmdlet modifies existing instances of the Microso [New-CsClsRegion](New-CsClsRegion.md) [Remove-CsClsRegion](Remove-CsClsRegion.md) - diff --git a/skype/skype-ps/skype/Set-CsClsScenario.md b/skype/skype-ps/skype/Set-CsClsScenario.md index 23c5b108a5..156d2a64db 100644 --- a/skype/skype-ps/skype/Set-CsClsScenario.md +++ b/skype/skype-ps/skype/Set-CsClsScenario.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclsscenario +online version: https://learn.microsoft.com/powershell/module/skype/set-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClsScenario schema: 2.0.0 @@ -197,4 +197,3 @@ Instead, the `Set-CsClsScenario` cmdlet modifies existing instances of the Micro ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsClsSearchTerm.md b/skype/skype-ps/skype/Set-CsClsSearchTerm.md index 0fafe4702d..f3cb33712c 100644 --- a/skype/skype-ps/skype/Set-CsClsSearchTerm.md +++ b/skype/skype-ps/skype/Set-CsClsSearchTerm.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclssearchterm +online version: https://learn.microsoft.com/powershell/module/skype/set-csclssearchterm applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClsSearchTerm schema: 2.0.0 @@ -187,4 +187,3 @@ Instead, the `Set-CsClsSearchTerm` cmdlet modifies existing instances of the Mic ## RELATED LINKS [Get-CsClsSearchTerm](Get-CsClsSearchTerm.md) - diff --git a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md b/skype/skype-ps/skype/Set-CsClsSecurityGroup.md index 6312375835..a0d8f37e29 100644 --- a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md +++ b/skype/skype-ps/skype/Set-CsClsSecurityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csclssecuritygroup +online version: https://learn.microsoft.com/powershell/module/skype/set-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsClsSecurityGroup schema: 2.0.0 @@ -210,4 +210,3 @@ Instead, the `Set-CsClsSecurityGroup` cmdlet modifies existing instances of the [New-CsClsSecurityGroup](New-CsClsSecurityGroup.md) [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) - diff --git a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md b/skype/skype-ps/skype/Set-CsCommonAreaPhone.md index eabbc81868..0339c1c04d 100644 --- a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md +++ b/skype/skype-ps/skype/Set-CsCommonAreaPhone.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscommonareaphone +online version: https://learn.microsoft.com/powershell/module/skype/set-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCommonAreaPhone schema: 2.0.0 @@ -349,4 +349,3 @@ However, if you include the PassThru parameter, the cmdlet will return instances [New-CsCommonAreaPhone](New-CsCommonAreaPhone.md) [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) - diff --git a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md b/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md index 1bdcc9992a..161abd1d7d 100644 --- a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md +++ b/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csconferencedisclaimer +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConferenceDisclaimer schema: 2.0.0 @@ -192,4 +192,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsConferenceDisclaimer](Get-CsConferenceDisclaimer.md) [Remove-CsConferenceDisclaimer](Remove-CsConferenceDisclaimer.md) - diff --git a/skype/skype-ps/skype/Set-CsConferenceServer.md b/skype/skype-ps/skype/Set-CsConferenceServer.md index 4754748cbb..b10649feaa 100644 --- a/skype/skype-ps/skype/Set-CsConferenceServer.md +++ b/skype/skype-ps/skype/Set-CsConferenceServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csconferenceserver +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferenceserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConferenceServer schema: 2.0.0 @@ -31,7 +31,7 @@ Set-CsConferenceServer [[-Identity] ] [-AppSharingSip ## DESCRIPTION Conference Servers (also known as A/V Conferencing Servers) are used to provide audio and video capabilities to conferences. In turn, the `Set-CsConferenceServer` cmdlet can be used to modify the properties of these servers; in particular, you can specify which ports are used for such things as audio traffic, video traffic and application sharing. -You can also use the `Set-CsConferenceServer` cmdlet to associate a given server with a Edge Server or Archiving Server. +You can also use the `Set-CsConferenceServer` cmdlet to associate a given server with an Edge Server or Archiving Server. ## EXAMPLES @@ -368,4 +368,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [Get-CsConferencingConfiguration](Get-CsConferencingConfiguration.md) [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md b/skype/skype-ps/skype/Set-CsConferencingConfiguration.md index dc4349dcd0..6af69082b4 100644 --- a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConferencingConfiguration schema: 2.0.0 @@ -685,4 +685,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsConferencingConfiguration](New-CsConferencingConfiguration.md) [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsConferencingPolicy.md b/skype/skype-ps/skype/Set-CsConferencingPolicy.md index 0ba1ec8de3..96b5bc05d9 100644 --- a/skype/skype-ps/skype/Set-CsConferencingPolicy.md +++ b/skype/skype-ps/skype/Set-CsConferencingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csconferencingpolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingpolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConferencingPolicy schema: 2.0.0 manager: bulenteg @@ -1075,4 +1075,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsConferencingPolicy](New-CsConferencingPolicy.md) [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md b/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md index e87084224e..e52a31a523 100644 --- a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csconfigurationstorelocation +online version: https://learn.microsoft.com/powershell/module/skype/set-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConfigurationStoreLocation schema: 2.0.0 @@ -255,4 +255,3 @@ The `Set-CsConfigurationStoreLocation` cmdlet does not return any objects or val [Get-CsConfigurationStoreLocation](Get-CsConfigurationStoreLocation.md) [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) - diff --git a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md b/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md index 9bf230e8f6..4852521547 100644 --- a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csconversationhistoryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsConversationHistoryConfiguration schema: 2.0.0 @@ -220,4 +220,3 @@ Instead, `Set-CsConversationHistoryConfiguration` modifies instances of the Micr [Get-CsConversationHistoryConfiguration](Get-CsConversationHistoryConfiguration.md) [Remove-CsConversationHistoryConfiguration](Remove-CsConversationHistoryConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsCpsConfiguration.md b/skype/skype-ps/skype/Set-CsCpsConfiguration.md index dc8e5d6f03..ae868b8cba 100644 --- a/skype/skype-ps/skype/Set-CsCpsConfiguration.md +++ b/skype/skype-ps/skype/Set-CsCpsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscpsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsCpsConfiguration schema: 2.0.0 @@ -264,4 +264,3 @@ Modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Call [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) - diff --git a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md b/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md index 5dd5a7f393..8f111fabab 100644 --- a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdeviceupdateconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDeviceUpdateConfiguration schema: 2.0.0 @@ -375,4 +375,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsDeviceUpdateConfiguration](New-CsDeviceUpdateConfiguration.md) [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md b/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md index 1a481cfdee..505b7d16bb 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdiagnosticconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDiagnosticConfiguration schema: 2.0.0 @@ -283,4 +283,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsDiagnosticsFilter](New-CsDiagnosticsFilter.md) [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md index 848b23262a..4d2cb97630 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdiagnosticheaderconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDiagnosticHeaderConfiguration schema: 2.0.0 @@ -250,4 +250,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsDiagnosticHeaderConfiguration](New-CsDiagnosticHeaderConfiguration.md) [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md b/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md index 9ebe876b01..01205b59cd 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdialinconferencingaccessnumber +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDialInConferencingAccessNumber schema: 2.0.0 @@ -422,4 +422,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Xds.Acc [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) - diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md b/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md index 48cf48e60d..05992d1033 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdialinconferencingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDialInConferencingConfiguration schema: 2.0.0 @@ -288,4 +288,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsDialInConferencingConfiguration](New-CsDialInConferencingConfiguration.md) [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md index 3a75ba8707..f9a7d636a3 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdialinconferencingdtmfconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDialInConferencingDtmfConfiguration schema: 2.0.0 @@ -370,4 +370,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsDialInConferencingDtmfConfiguration](New-CsDialInConferencingDtmfConfiguration.md) [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsDialPlan.md b/skype/skype-ps/skype/Set-CsDialPlan.md index ab43fd0171..f8e44ed1dd 100644 --- a/skype/skype-ps/skype/Set-CsDialPlan.md +++ b/skype/skype-ps/skype/Set-CsDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdialplan +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDialPlan schema: 2.0.0 @@ -353,4 +353,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsDirector.md b/skype/skype-ps/skype/Set-CsDirector.md index 412bbfe37c..49d7fa107e 100644 --- a/skype/skype-ps/skype/Set-CsDirector.md +++ b/skype/skype-ps/skype/Set-CsDirector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csdirector +online version: https://learn.microsoft.com/powershell/module/skype/set-csdirector applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsDirector schema: 2.0.0 @@ -318,4 +318,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsEdgeServer.md b/skype/skype-ps/skype/Set-CsEdgeServer.md index 6e3a53e9e5..5f2b5044cf 100644 --- a/skype/skype-ps/skype/Set-CsEdgeServer.md +++ b/skype/skype-ps/skype/Set-CsEdgeServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csedgeserver +online version: https://learn.microsoft.com/powershell/module/skype/set-csedgeserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsEdgeServer schema: 2.0.0 @@ -432,4 +432,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md index 1025caee9b..25d66021cd 100644 --- a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csenhancedemergencyservicedisclaimer +online version: https://learn.microsoft.com/powershell/module/skype/set-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsEnhancedEmergencyServiceDisclaimer schema: 2.0.0 @@ -175,4 +175,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Loc [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) [Get-CsLocationPolicy](Get-CsLocationPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsExUmContact.md b/skype/skype-ps/skype/Set-CsExUmContact.md index 58171eca36..aaee007975 100644 --- a/skype/skype-ps/skype/Set-CsExUmContact.md +++ b/skype/skype-ps/skype/Set-CsExUmContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csexumcontact +online version: https://learn.microsoft.com/powershell/module/skype/set-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsExUmContact schema: 2.0.0 @@ -315,4 +315,3 @@ When the PassThru parameter is used, it also returns an object of this type. [Get-CsExUmContact](Get-CsExUmContact.md) [Move-CsExUmContact](Move-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md index 16b8b273a6..7261e645e0 100644 --- a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md +++ b/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csexternalaccesspolicy -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalaccesspolicy +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsExternalAccessPolicy schema: 2.0.0 author: tomkau @@ -12,27 +12,27 @@ ms.reviewer: rogupta # Set-CsExternalAccessPolicy ## SYNOPSIS +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter EnablePublicCloudAccess can no longer be used. + Enables you to modify the properties of an existing external access policy. External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. - This cmdlet was introduced in Lync Server 2010. - ## SYNTAX ### Identity (Default) ``` Set-CsExternalAccessPolicy [-Tenant ] [-Description ] [-EnableFederationAccess ] [-EnableAcsFederationAccess ] - [-EnableXmppAccess ] [-EnablePublicCloudAccess ] - [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [[-Identity] ] + [-EnableXmppAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance ``` Set-CsExternalAccessPolicy [-Tenant ] [-Description ] [-EnableFederationAccess ] [-EnableAcsFederationAccess ] - [-EnableXmppAccess ] [-EnablePublicCloudAccess ] + [-EnableXmppAccess ] [-EnablePublicCloudAudioVideoAccess ] [-EnableTeamsConsumerAccess ] [-EnableTeamsConsumerInbound ] [-EnableOutsideAccess ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -45,25 +45,20 @@ That might be sufficient to meet your communication needs. If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. External access policies can grant (or revoke) the ability of your users to do any or all of the following: -1. -Communicate with people who have SIP accounts with a federated organization. +1. Communicate with people who have SIP accounts with a federated organization. Note that enabling federation alone will not provide users with this capability. Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. -2. -(Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](/powershell/module/teams/set-csteamsacsfederationconfiguration). -3. -Access Skype for Business Server over the Internet, without having to first log on to your internal network. +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. -4. -Communicate with people who have SIP accounts with a public instant messaging service such as Skype. +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. -The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant + The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant -5. -(Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/teams/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](/powershell/module/skype/set-cstenantfederationconfiguration) or Teams admin center under the External Access setting. After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. @@ -79,7 +74,6 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. - ### -------------------------- Example 2 ------------------------ ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True @@ -89,31 +83,18 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. - ### -------------------------- Example 3 ------------------------ ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` Example 3 enables federation access for all the external access policies that have been configured at the per-user scope. -To carry out this task, the first thing the command does is use the `Get-CsExternalAcessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. +To carry out this task, the first thing the command does is use the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. (The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. - ### -------------------------- Example 4 ------------------------ ``` -Get-CsExternalAccessPolicy | Where-Object {$_.EnablePublicCloudAccess -eq $True} | Set-CsExternalAccessPolicy -EnableFederationAccess $True -``` - -In Example 4, federation access is enabled for all the external access policies that allow public cloud access. -To do this, the command first uses the `Get-CsExternalAccessPolicy` cmdlet to return a collection of all the external access policies currently configured for use in the organization. -This collection is piped to the `Where-Object` cmdlet, which picks out only those policies where the EnablePublicCloudAccess property is equal to True. -The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which takes each policy and sets the EnableFederationAccess property to True. -The net result: all external access policies that allow public cloud access will also allow federation access. - -### -------------------------- Example 5 ------------------------ -``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true ``` @@ -128,7 +109,6 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. - ## PARAMETERS ### -Identity @@ -144,7 +124,7 @@ Note that wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -160,7 +140,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi ```yaml Type: PSObject Parameter Sets: Instance -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -174,11 +154,10 @@ Accept wildcard characters: False Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. - ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -193,11 +172,10 @@ Indicates whether the user is allowed to communicate with people who have SIP ac Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -208,7 +186,9 @@ Accept wildcard characters: False ``` ### -EnableAcsFederationAccess -Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. +Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. + +Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. @@ -217,7 +197,7 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False Position: Named @@ -226,35 +206,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePublicCloudAccess -Indicates whether the user is allowed to communicate with people who have SIP accounts with a public Internet connectivity provider such as MSN. -Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. -The default value is False. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -EnablePublicCloudAudioVideoAccess Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -272,11 +232,10 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -294,11 +253,10 @@ To enable just for a selected set of users, use the Set-CsExternalAccessPolicy c Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -311,11 +269,10 @@ Accept wildcard characters: False ### -Force Suppresses the display of any non-fatal error message that might occur when running the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -328,7 +285,6 @@ Accept wildcard characters: False ### -WhatIf Describes what would happen if you executed the command without actually executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -345,7 +301,6 @@ Accept wildcard characters: False ### -Confirm Prompts you for confirmation before executing the command. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -363,11 +318,10 @@ Accept wildcard characters: False Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -381,11 +335,10 @@ Accept wildcard characters: False Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. The default value is False. - ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False @@ -405,7 +358,6 @@ You can return the tenant ID for each of your Skype for Business Online tenants `Get-CsTenant | Select-Object DisplayName, TenantID` - ```yaml Type: Guid Parameter Sets: (All) diff --git a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md index 6ac2c7bcf6..58dfe5fefc 100644 --- a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy applicable: Skype for Business Online title: Set-CsExternalUserCommunicationPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsExternalUserCommunicationPolicy @@ -225,4 +225,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md b/skype/skype-ps/skype/Set-CsFIPSConfiguration.md index d5d7da6393..609a96b73c 100644 --- a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md +++ b/skype/skype-ps/skype/Set-CsFIPSConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csfipsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsFIPSConfiguration schema: 2.0.0 @@ -215,4 +215,3 @@ Instead, the `Set-CsFIPSConfiguration` cmdlet modifies existing instances of the [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md b/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md index 0a52ccb3ec..711fda67d7 100644 --- a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csfiletransferfilterconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsFileTransferFilterConfiguration schema: 2.0.0 @@ -277,4 +277,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md b/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md index 992ef08705..5b56d01e9e 100644 --- a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csgrouppickupuserorbit +online version: https://learn.microsoft.com/powershell/module/skype/set-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsGroupPickupUserOrbit schema: 2.0.0 @@ -43,7 +43,7 @@ In this case, the display name "Ken Myer". ### -Orbit Specifies the new group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. -For more information on creating call park orbits, see [New-CsCallParkOrbit](https://docs.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). +For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). @@ -145,4 +145,3 @@ This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.Gr ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md b/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md index 573ff350dc..6ad6748d7f 100644 --- a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cshealthmonitoringconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsHealthMonitoringConfiguration schema: 2.0.0 @@ -267,4 +267,3 @@ Instead, the `Set-CsHealthMonitoringConfiguration` cmdlet modifies existing inst [New-CsHealthMonitoringConfiguration](New-CsHealthMonitoringConfiguration.md) [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md b/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md index cd95c06931..812ec3758b 100644 --- a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cshostedvoicemailpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsHostedVoicemailPolicy schema: 2.0.0 @@ -268,4 +268,3 @@ This cmdlet modifies an object of type Microsoft.Rtc.Management.WritableConfig.P [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsHostingProvider.md b/skype/skype-ps/skype/Set-CsHostingProvider.md index 7ca401955a..0e74e387f7 100644 --- a/skype/skype-ps/skype/Set-CsHostingProvider.md +++ b/skype/skype-ps/skype/Set-CsHostingProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cshostingprovider +online version: https://learn.microsoft.com/powershell/module/skype/set-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsHostingProvider schema: 2.0.0 @@ -343,4 +343,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsHostingProvider](New-CsHostingProvider.md) [Remove-CsHostingProvider](Remove-CsHostingProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsHuntGroup.md b/skype/skype-ps/skype/Set-CsHuntGroup.md deleted file mode 100644 index ec5c1b716e..0000000000 --- a/skype/skype-ps/skype/Set-CsHuntGroup.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cshuntgroup -applicable: Skype for Business Online -title: Set-CsHuntGroup -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsHuntGroup - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Set-CsCallQueue](Set-CsCallQueue.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md b/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md index d241d61daf..33c98d57dc 100644 --- a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsHybridApplicationEndpoint schema: 2.0.0 @@ -23,7 +23,7 @@ Set-CsHybridApplicationEndpoint [-Identity] [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. This cmdlet will be removed in the near future. -> -> Please use the [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) and [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) cmdlets instead. - -The `Set-CsOnlineApplicationEndpoint` is used to update a Trusted Application Endpoint for a tenant. - -## SYNTAX -``` -Set-CsOnlineApplicationEndpoint [-CallbackUri ] [-Name ] [-Uri] [-Audience ] - [-Ring ] [-PhoneNumber ] [-IsInternalRun ] [-Tenant ] - [-RunFullProvisioningFlow ] [-DomainController ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -This cmdlet is used to update a Trusted Application Endpoint for a tenant. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsOnlineApplicationEndpoint -Uri "sip:sample@domain.com" -PhoneNumber "19841110909" -``` - -This example assigns the service number "19841110909" to the trusted application with the sip uri "sample@domain.com". - -## PARAMETERS - -### -Uri -Sip Uri that identifies the tenant specific endpoint for the application. This must be a unique URI that does not conflict with an existing user in the tenant. Requests sent to this endpoint will trigger the Trusted Application API sending an event to the application, indicating that someone has sent a request. For example: helpdesk@contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SipUri -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Audience -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallbackUri -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -A friendly name of your application within Skype for Business Online. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PhoneNumber -The service number assigned to the trusted application endpoint. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInternalRun -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunFullProvisioningFlow -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -[Get-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint) - -[New-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint) - -[Remove-CsOnlineApplicationEndpoint](https://docs.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://docs.microsoft.com/skype-sdk/trusted-application-api/docs/trustedapplicationendpoint) diff --git a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md deleted file mode 100644 index c0c7079f95..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlineapplicationinstance -applicable: Skype for Business Online -title: Set-CsOnlineApplicationInstance -schema: 2.0.0 -manager: bulenteg -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# Set-CsOnlineApplicationInstance - -## SYNOPSIS -Updates an application instance in Azure Active Directory. - -**Note**: The use of this cmdlet for assigning phone numbers will be deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) -and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. The new cmdlets are currently not supported for customers and tenants -that are or have been enabled for Regionally Hosted Meetings for Skype for Business Online. These customers should continue to use Set-CsOnlineApplicationInstance. - -## SYNTAX - -``` -Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] ] [[-ApplicationId] ] - [[-DisplayName] ] [-Tenant ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet is used to update an application instance in Azure Active Directory. This same cmdlet is also run when creating a new resource account using Teams Admin Center. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -```powershell -Set-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -OnpremPhoneNumber +14250000000 -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" -``` - -This example shows updating OnpremPhoneNumber, ApplicationId, DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". - -The following are the application ID's for each type of application instance types: - -Auto Attendant: ce933385-9390-45d1-9512-c8d228074e07 -Call Queue: 11cd3e2e-fccb-42ad-ad00-878b93575e07 - -## PARAMETERS - -### -Identity -The URI or ID of the application instance to update. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnpremPhoneNumber -**Note**: Using this parameter will be deprecated. Use the new Set-CsPhoneNumberAssignment cmdlet instead. - -Assigns a hybrid (on-premise) telephone number to the application instance. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -The application ID. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The display name. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md b/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md deleted file mode 100644 index 932ed2ccd3..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinedirectoryuser -applicable: Skype for Business Online -title: Set-CsOnlineDirectoryUser -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsOnlineDirectoryUser - -## SYNOPSIS -Use the `Set-CsOnlineDirectoryUser` cmdlet to create or modify a PSTN enabled user in Business Voice Directory. -This should be done via provisioning or operations in special cases. - -## SYNTAX - -``` -Set-CsOnlineDirectoryUser [-Identity] [-Tenant ] [-Ring ] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Identity -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -You can use the `Get-CsOnlineUser` cmdlet to identify the users you want to modify. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ring -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md b/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md deleted file mode 100644 index 0f7e188c72..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,507 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinenumberportinorder -applicable: Skype for Business Online -title: Set-CsOnlineNumberPortInOrder -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsOnlineNumberPortInOrder - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. -New third party provider ports should be provisioned through the Skype for Business Online admin center. - -## SYNTAX - -``` -Set-CsOnlineNumberPortInOrder [-Tenant ] -PortInOrderId [-LOABase64PayLoad ] - [-LOAContentType ] [-LOAAuthorizingPerson ] [-SubscriberArea ] - [-SubscriberCity ] [-SubscriberCountry ] [-SubscriberStreetName ] - [-SubscriberBuildingNumber ] [-SubscriberZipCode ] [-SubscriberBusinessName ] - [-BillingTelephoneNumber ] [-SubscriberFirstName ] [-SubscriberLastName ] - [-EmailAddresses ] [-RequestedFocDate ] [-LosingTelcoPin ] - [-LosingTelcoAccountId ] [-SubscriberAddressLine1 ] [-SubscriberAddressLine2 ] - [-IsPartialPort ] [-SubscriberAddressLine3 ] [-FriendlyName ] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -{{Fill in the Description}} - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - - -## PARAMETERS - -### -PortInOrderId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BillingTelephoneNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPartialPort -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAAuthorizingPerson -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOABase64PayLoad -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LOAContentType -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoAccountId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LosingTelcoPin -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestedFocDate -This parameter is reserved for internal Microsoft use. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine1 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine2 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberAddressLine3 -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberArea -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBuildingNumber -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberBusinessName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberCountry -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberFirstName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberLastName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberStreetName -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriberZipCode -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md b/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md deleted file mode 100644 index 821b88b808..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinenumberportoutorderpin -applicable: Skype for Business Online -title: Set-CsOnlineNumberPortOutOrderPin -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsOnlineNumberPortOutOrderPin - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. - -## SYNTAX - -``` -Set-CsOnlineNumberPortOutOrderPin [-Tenant ] [-PortOrderPin ] [-DomainController ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet is reserved for Microsoft internal use only. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortOrderPin -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md b/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md deleted file mode 100644 index 793257ffd2..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceuserbulk -applicable: Skype for Business Online -title: Set-CsOnlineVoiceUserBulk -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsOnlineVoiceUserBulk - -## SYNOPSIS -Note: **This cmdlet has been deprecated and no longer used.** - -## SYNTAX - -``` -Set-CsOnlineVoiceUserBulk [-Tenant ] [-NumberAssignmentDetails <>] [-DomainController ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Provide the detailed description here. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Insert example commands for example 1. -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Confirm -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -PARAMVALUE: Fqdn - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberAssignmentDetails -PARAMVALUE: List - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -PARAMVALUE: Guid - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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/skype/skype-ps/skype/Set-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Set-CsOrganizationalAutoAttendant.md deleted file mode 100644 index 055b6aa04f..0000000000 --- a/skype/skype-ps/skype/Set-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csorganizationalautoattendant -applicable: Skype for Business Online -title: Set-CsOrganizationalAutoAttendant -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsOrganizationalAutoAttendant - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Set-CsAutoAttendant](Set-CsAutoAttendant.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md index 35c8cac16c..02b03a405f 100644 --- a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csoutboundcallingnumbertranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsOutboundCallingNumberTranslationRule schema: 2.0.0 @@ -232,4 +232,3 @@ Instead, the `Set-CsOutboundCallingNumberTranslationRule` cmdlet modifies existi [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md b/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md index f2b6106f9c..8840737092 100644 --- a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md +++ b/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csoutboundtranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsOutboundTranslationRule schema: 2.0.0 @@ -256,4 +256,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.T [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsPartnerApplication.md b/skype/skype-ps/skype/Set-CsPartnerApplication.md index 82e484dadb..b1273b0d76 100644 --- a/skype/skype-ps/skype/Set-CsPartnerApplication.md +++ b/skype/skype-ps/skype/Set-CsPartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspartnerapplication +online version: https://learn.microsoft.com/powershell/module/skype/set-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPartnerApplication schema: 2.0.0 @@ -131,9 +131,9 @@ Accept wildcard characters: False Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these: -`$x = Get-Content "C:\Certificates\PartnerApplication.cer" -Encoding Byte` +`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` -`$y = \[Convert\]::ToBase64String($x)` +`$y = [Convert]::ToBase64String($x)` You can then use this syntax to assign the certificate data stored in the variable $y: @@ -375,4 +375,3 @@ Instead, the `Set-CsPartnerApplication` cmdlet modifies existing instances of th [New-CsPartnerApplication](New-CsPartnerApplication.md) [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md b/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md index e45ad2dd4b..6bb38b73c1 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatactiveserver -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatactiveserver +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatActiveServer schema: 2.0.0 manager: rogupta @@ -203,4 +203,3 @@ None. ## RELATED LINKS [Set-CsPersistentChatState](Set-CsPersistentChatState.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md b/skype/skype-ps/skype/Set-CsPersistentChatAddin.md index 49dd1c47e1..57d307c906 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatAddin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchataddin +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatAddin schema: 2.0.0 manager: rogupta @@ -54,7 +54,7 @@ Set-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatA ``` Example 1 modifies the URL assigned to the Persistent Chat add-in ITPersistentChatAddin. -In this case, the URL is changed to https://atl-cs-001.litwareinc.com/itchat2. +In this case, the URL is changed to `https://atl-cs-001.litwareinc.com/itchat2`. ## PARAMETERS @@ -183,4 +183,3 @@ Instead, the `Set-CsPersistentChatAddin` cmdlet modifies existing instances of t [New-CsPersistentChatAddin](New-CsPersistentChatAddin.md) [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md b/skype/skype-ps/skype/Set-CsPersistentChatCategory.md index 7929d32d6d..5398bb8787 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcategory +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatCategory schema: 2.0.0 manager: rogupta @@ -387,4 +387,3 @@ Instead, the `Set-CsPersistentChatCategory` cmdlet modifies existing instances o [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md index b9804216d3..9dabe65046 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcomplianceconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta @@ -357,4 +357,3 @@ Instead, the `Set-CsPersistentChatComplianceConfiguration` cmdlet modifies exist [New-CsPersistentChatComplianceConfiguration](New-CsPersistentChatComplianceConfiguration.md) [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md index f30dd63660..f174447fa0 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2015 title: Set-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta @@ -276,4 +276,3 @@ Instead, the `Set-CsPersistentChatConfiguration` cmdlet modifies existing instan [New-CsPersistentChatConfiguration](New-CsPersistentChatConfiguration.md) [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md index a0d6ac8542..0be410776e 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatpolicy +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta @@ -235,4 +235,3 @@ Instead, the `Set-CsPersistentChatPolicy` cmdlet modifies existing instances of [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md b/skype/skype-ps/skype/Set-CsPersistentChatRoom.md index 8be9df3859..0a6014d89c 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatRoom.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatroom +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatRoom schema: 2.0.0 manager: rogupta @@ -485,4 +485,3 @@ Instead, the `Set-CsPersistentChatRoom` cmdlet modifies existing instances of th [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) - diff --git a/skype/skype-ps/skype/Set-CsPersistentChatState.md b/skype/skype-ps/skype/Set-CsPersistentChatState.md index 70f4e797c4..b0d38cefb9 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatState.md +++ b/skype/skype-ps/skype/Set-CsPersistentChatState.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspersistentchatstate -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatstate +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatState schema: 2.0.0 manager: rogupta @@ -179,4 +179,3 @@ Instead, the `Set-CsPersistentChatState` cmdlet modifies existing instances of t [Get-CsPersistentChatState](Get-CsPersistentChatState.md) [Set-CsPersistentChatActiveServer](Set-CsPersistentChatActiveServer.md) - diff --git a/skype/skype-ps/skype/Set-CsPinPolicy.md b/skype/skype-ps/skype/Set-CsPinPolicy.md index 792867a008..8432fb8fd2 100644 --- a/skype/skype-ps/skype/Set-CsPinPolicy.md +++ b/skype/skype-ps/skype/Set-CsPinPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspinpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPinPolicy schema: 2.0.0 @@ -362,4 +362,3 @@ Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Manage [New-CsPinPolicy](New-CsPinPolicy.md) [Remove-CsPinPolicy](Remove-CsPinPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md index f2b97a72c3..9bf4ba1881 100644 --- a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md +++ b/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPlatformServiceSettings schema: 2.0.0 manager: rogupta @@ -13,7 +13,7 @@ ms.reviewer: # Set-CsPlatformServiceSettings ## SYNOPSIS -Modifies the Skype for Business on Mac capabilites in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). +Modifies the Skype for Business on Mac capabilities in your organization. This cmdlet was introduced in Skype for Business Server 2015 Cumulative Update 6 (December 2017). ## SYNTAX @@ -293,8 +293,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) +[New-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings?view=skype-ps) -[Get-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) +[Get-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings?view=skype-ps) -[Remove-CsPlatformServiceSettings](https://docs.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) +[Remove-CsPlatformServiceSettings](https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsPresenceManagementState.md b/skype/skype-ps/skype/Set-CsPresenceManagementState.md index b1a7671e1e..863e995fa9 100644 --- a/skype/skype-ps/skype/Set-CsPresenceManagementState.md +++ b/skype/skype-ps/skype/Set-CsPresenceManagementState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspresencemanagementstate +online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencemanagementstate applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPresenceManagementState schema: 2.0.0 @@ -261,4 +261,3 @@ None. ## RELATED LINKS [Get-CsPresenceManagementState](Get-CsPresenceManagementState.md) - diff --git a/skype/skype-ps/skype/Set-CsPresencePolicy.md b/skype/skype-ps/skype/Set-CsPresencePolicy.md index 3ddc2bcca6..b700f28738 100644 --- a/skype/skype-ps/skype/Set-CsPresencePolicy.md +++ b/skype/skype-ps/skype/Set-CsPresencePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspresencepolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPresencePolicy schema: 2.0.0 @@ -290,4 +290,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsPresencePolicy](New-CsPresencePolicy.md) [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsPresenceProvider.md b/skype/skype-ps/skype/Set-CsPresenceProvider.md index 6af5f68403..253ee70774 100644 --- a/skype/skype-ps/skype/Set-CsPresenceProvider.md +++ b/skype/skype-ps/skype/Set-CsPresenceProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspresenceprovider +online version: https://learn.microsoft.com/powershell/module/skype/set-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPresenceProvider schema: 2.0.0 @@ -170,4 +170,3 @@ Instead, the `Set-CsPresenceProvider` cmdlet modifies existing instances of the [New-CsPresenceProvider](New-CsPresenceProvider.md) [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md index e86b638d33..2cca0f6368 100644 --- a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csprivacyconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csprivacyconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPrivacyConfiguration schema: 2.0.0 manager: bulenteg @@ -178,6 +178,7 @@ In advanced privacy mode, only people on your Contacts list will be allowed to v If False, your presence information will be available to anyone in your organization. The default value is False. +For information about privacy mode in Microsoft Teams, see [User presence in Teams](/microsoftteams/presence-admins). ```yaml Type: Boolean @@ -286,4 +287,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. [New-CsPrivacyConfiguration](New-CsPrivacyConfiguration.md) [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsProxyConfiguration.md b/skype/skype-ps/skype/Set-CsProxyConfiguration.md index daa1e485d5..9d347a53bc 100644 --- a/skype/skype-ps/skype/Set-CsProxyConfiguration.md +++ b/skype/skype-ps/skype/Set-CsProxyConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csproxyconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsProxyConfiguration schema: 2.0.0 @@ -620,4 +620,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsProxyConfiguration](New-CsProxyConfiguration.md) [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsPstnGateway.md b/skype/skype-ps/skype/Set-CsPstnGateway.md index 0234c94697..652c120b20 100644 --- a/skype/skype-ps/skype/Set-CsPstnGateway.md +++ b/skype/skype-ps/skype/Set-CsPstnGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspstngateway +online version: https://learn.microsoft.com/powershell/module/skype/set-cspstngateway applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPstnGateway schema: 2.0.0 @@ -285,4 +285,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsPstnUsage.md b/skype/skype-ps/skype/Set-CsPstnUsage.md index b9f32dd13c..d588c47094 100644 --- a/skype/skype-ps/skype/Set-CsPstnUsage.md +++ b/skype/skype-ps/skype/Set-CsPstnUsage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspstnusage +online version: https://learn.microsoft.com/powershell/module/skype/set-cspstnusage applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPstnUsage schema: 2.0.0 @@ -198,4 +198,3 @@ Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig. ## RELATED LINKS [Get-CsPstnUsage](Get-CsPstnUsage.md) - diff --git a/skype/skype-ps/skype/Set-CsPublicProvider.md b/skype/skype-ps/skype/Set-CsPublicProvider.md index a9c47472ff..4895b36792 100644 --- a/skype/skype-ps/skype/Set-CsPublicProvider.md +++ b/skype/skype-ps/skype/Set-CsPublicProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspublicprovider +online version: https://learn.microsoft.com/powershell/module/skype/set-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPublicProvider schema: 2.0.0 @@ -244,4 +244,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsPublicProvider](New-CsPublicProvider.md) [Remove-CsPublicProvider](Remove-CsPublicProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md index 14ff6b60c9..7a86381463 100644 --- a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration -applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPushNotificationConfiguration schema: 2.0.0 manager: bulenteg @@ -266,4 +266,3 @@ Instead, the `Set-CsPushNotificationConfiguration` cmdlet modifies existing inst ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsQoEConfiguration.md b/skype/skype-ps/skype/Set-CsQoEConfiguration.md index db861c69b1..257965025e 100644 --- a/skype/skype-ps/skype/Set-CsQoEConfiguration.md +++ b/skype/skype-ps/skype/Set-CsQoEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csqoeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsQoEConfiguration schema: 2.0.0 @@ -312,4 +312,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Remove-CsQoEConfiguration](Remove-CsQoEConfiguration.md) [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsRegistrar.md b/skype/skype-ps/skype/Set-CsRegistrar.md index d371114dd1..b304b0a075 100644 --- a/skype/skype-ps/skype/Set-CsRegistrar.md +++ b/skype/skype-ps/skype/Set-CsRegistrar.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csregistrar +online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrar applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRegistrar schema: 2.0.0 @@ -639,4 +639,3 @@ Instead, the command modifies existing instances of the Microsoft.Rtc.Management ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md b/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md index b8839bcf7c..42491be2c9 100644 --- a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md +++ b/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csregistrarconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRegistrarConfiguration schema: 2.0.0 @@ -416,4 +416,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsRegistrarConfiguration](New-CsRegistrarConfiguration.md) [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsReportingConfiguration.md b/skype/skype-ps/skype/Set-CsReportingConfiguration.md index f3170e78d8..9e96050de2 100644 --- a/skype/skype-ps/skype/Set-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsReportingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csreportingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsReportingConfiguration schema: 2.0.0 @@ -59,7 +59,7 @@ Set-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.l ``` The command shown in Example 1 modifies the reporting URL for the reporting configuration settings with the Identity service:MonitoringDatabase:atl-sql-002.litwareinc.com. -In this example, the reporting URL is changed to "https://atl-sql-002.litwareinc.com/lync_reports". +In this example, the reporting URL is changed to `https://atl-sql-002.litwareinc.com/lync_reports`. ## PARAMETERS @@ -187,4 +187,3 @@ Instead, the `Set-CsReportingConfiguration` cmdlet modifies existing instances o [New-CsReportingConfiguration](New-CsReportingConfiguration.md) [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md b/skype/skype-ps/skype/Set-CsRgsAgentGroup.md index 9165465dff..287057404c 100644 --- a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md +++ b/skype/skype-ps/skype/Set-CsRgsAgentGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csrgsagentgroup +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRgsAgentGroup schema: 2.0.0 @@ -207,4 +207,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsAgentGroup](New-CsRgsAgentGroup.md) [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsConfiguration.md b/skype/skype-ps/skype/Set-CsRgsConfiguration.md index a2d1882a8e..6114842831 100644 --- a/skype/skype-ps/skype/Set-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Set-CsRgsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csrgsconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRgsConfiguration schema: 2.0.0 @@ -66,7 +66,7 @@ In turn, those computers are piped to the `ForEach-Object` cmdlet. ### -------------------------- Example 3 ------------------------ ``` -$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content (Get-Content C:\Media\WhileYouWait.wav -Encoding byte -ReadCount 0) +$x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) Set-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -DefaultMusicOnHoldFile $x ``` @@ -76,13 +76,11 @@ To perform this task, the first command uses `Import-CsRgsAudioFile` to import t In addition to the Identity parameter (which specifies the service location), the FileName parameter is used to specify the file name of the file being imported. Equally important, the Content parameter is used to import the audio file. -File importing is carried out by calling the `Get-Content` cmdlet followed by the path to the file being imported. -`Get-Content` also requires you to set the encoding type to byte and the ReadCount to 0. -(Setting the ReadCount to 0 ensures that the entire file is read in a single operation). The imported file is then stored in a variable named $x. +File importing is carried out by using the `[System.IO.File]::ReadAllBytes` command with the path to the file being imported. +The imported file is then stored in a variable named $x. After the file has been imported, `Set-CsRgsConfiguration` is called in order to set the DefaultMusicOnHoldFile property to the audio file stored in $x. - ## PARAMETERS ### -Identity @@ -251,4 +249,3 @@ Instead, the cmdlet configures existing instances of the Microsoft.Rtc.Rgs.Manag [Get-CsRgsConfiguration](Get-CsRgsConfiguration.md) [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md b/skype/skype-ps/skype/Set-CsRgsHolidaySet.md index 59c317889e..479d34c95d 100644 --- a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md +++ b/skype/skype-ps/skype/Set-CsRgsHolidaySet.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csrgsholidayset +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRgsHolidaySet schema: 2.0.0 @@ -209,4 +209,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md b/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md index 3867e2ed5d..2357b448fd 100644 --- a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csrgshoursofbusiness +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRgsHoursOfBusiness schema: 2.0.0 @@ -202,4 +202,3 @@ Modifies existing instances of the Microsoft.Rtc.Rgs.Management.WriteableSetting [New-CsRgsTimeRange](New-CsRgsTimeRange.md) [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsQueue.md b/skype/skype-ps/skype/Set-CsRgsQueue.md index 009c7935ec..4fbf3f12e4 100644 --- a/skype/skype-ps/skype/Set-CsRgsQueue.md +++ b/skype/skype-ps/skype/Set-CsRgsQueue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csrgsqueue +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRgsQueue schema: 2.0.0 @@ -184,4 +184,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsQueue](New-CsRgsQueue.md) [Remove-CsRgsQueue](Remove-CsRgsQueue.md) - diff --git a/skype/skype-ps/skype/Set-CsRgsWorkflow.md b/skype/skype-ps/skype/Set-CsRgsWorkflow.md index c3e77a6e0c..2a4c7f6b0e 100644 --- a/skype/skype-ps/skype/Set-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/Set-CsRgsWorkflow.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csrgsworkflow +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRgsWorkflow schema: 2.0.0 @@ -83,7 +83,9 @@ After the description has been changed, command 3 uses the `Set-CsRgsWorkflow` t ### -------------------------- Example 3 ------------------------ ``` -$musicFile = Get-Content -ReadCount 0 -Encoding Byte C:\MediaFiles\Hold.wav | Import-CsRgsAudioFile -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -FileName "HelpDeskHoldMusic.wav" +$musicFile = [System.IO.File]::ReadAllBytes('C:\MediaFiles\Hold.wav') | Import-CsRgsAudioFile -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -FileName "HelpDeskHoldMusic.wav" + + $y = Get-CsRgsWorkflow -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -94,7 +96,7 @@ Set-CsRgsWorkflow -Instance $y The commands shown in Example 3 import a new Response Group audio file, then assign this audio file to an existing workflow. To do this, the first command in the example imports the new audio file. -This is done by calling the `Get-Content` cmdlet in order to read in the audio file (C:\MediaFiles\Hold.wav) byte-by-byte; to ensure that the audio file is read in correctly, you must include the ReadCount parameter (set to 0) and the Encoding parameter (set to Byte). +This is done by using the `[System.IO.File]::ReadAllBytes` command in order to read in the audio file (C:\MediaFiles\Hold.wav) byte-by-byte. After the audio file has been read in, the data is piped to `New-CsRgsAudioFile`, which creates a new file on ApplicationServer:atl-cs-001.litwareinc.com. An object reference to this file (which has the name HelpDeskHoldMusic.wav), is stored in a variable named $musicFile. @@ -204,4 +206,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Managem [New-CsRgsWorkflow](New-CsRgsWorkflow.md) [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) - diff --git a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md b/skype/skype-ps/skype/Set-CsRoutingConfiguration.md index ada20f85fe..5a2141d994 100644 --- a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsRoutingConfiguration schema: 2.0.0 @@ -244,4 +244,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Get-CsVoiceRoute](Get-CsVoiceRoute.md) [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsServerApplication.md b/skype/skype-ps/skype/Set-CsServerApplication.md index 6d208d29bb..96b56c6e53 100644 --- a/skype/skype-ps/skype/Set-CsServerApplication.md +++ b/skype/skype-ps/skype/Set-CsServerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csserverapplication +online version: https://learn.microsoft.com/powershell/module/skype/set-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsServerApplication schema: 2.0.0 @@ -174,7 +174,7 @@ Accept wildcard characters: False ### -Uri Unique Uniform Resource Identifier (URI) for the application. -For example, the QoEAgent application has the URI http://www.microsoft.com/LCS/QoEAgent. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml Type: String @@ -286,4 +286,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsServerApplication](New-CsServerApplication.md) [Remove-CsServerApplication](Remove-CsServerApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md index 6c3bdad99f..c34fbf16bf 100644 --- a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cssimpleurlconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSimpleUrlConfiguration schema: 2.0.0 @@ -35,12 +35,12 @@ Set-CsSimpleUrlConfiguration [-Instance ] [-SimpleUrl ## DESCRIPTION In Microsoft Office Communications Server 2007 R2, meetings had URLs similar to this: -https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t +`https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t` However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Microsoft Lync Server 2010 help overcome those problems by providing users with URLs that look more like this: -https://meet.litwareinc.com/kenmyer/071200 +`https://meet.litwareinc.com/kenmyer/071200` Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. @@ -94,10 +94,10 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUr ``` Example 2 shows how a new URL can be added to an existing collection of simple URLs. -To begin with, the first command in the example uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To begin with, the first command in the example uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. In the second command, the `New-CsSimpleUrl` cmdlet is used to create an in-memory-only instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com` and the SimpleUrl property is set to $urlEntry, with $urlEntry being the URL entry created in the first command. After the URL has been created (and stored in the object reference $simpleUrl) the final command in the example adds the new URL to the simple URL collection for the Redmond site. This is done by using the `Set-CsSimpleUrlConfiguration` cmdlet, the SimpleUrl parameter and the parameter value @{Add=$simpleUrl}. @@ -115,10 +115,10 @@ Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Remove=$simpl The commands shown in Example 3 demonstrate how you can delete a single URL from a simple URL collection. Because the `Set-CsSimpleUrlConfiguration` cmdlet needs to work with URL objects, the example starts by creating a new object that contains the exact same property values as the URL to be deleted. -To do that, the first command uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry. +To do that, the first command uses the `New-CsSimpleUrlEntry` cmdlet to create a URL entry that points to `https://meet.fabrikam.com`; this URL entry is stored in a variable named $urlEntry. After the URL entry has been created, the second command uses the `New-CsSimpleUrl` cmdlet to create an in-memory instance of a simple URL. -In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com; and the SimpleUrl property is set to $urlEntry, $urlEntry being the URL entry created in the first command. +In this example, the URL Component is set to Meet; the domain is set to fabrikam.com; the ActiveUrl is set to `https://meet.fabrikam.com`; and the SimpleUrl property is set to $urlEntry, $urlEntry being the URL entry created in the first command. This creates an in-memory URL ($simpleUrl) that has the same property values as the URL to be deleted. The final command in the example then deletes the URL from the simple URL collection for the Redmond site. @@ -287,4 +287,3 @@ None. [New-CsSimpleUrlEntry](New-CsSimpleUrlEntry.md) [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsSipDomain.md b/skype/skype-ps/skype/Set-CsSipDomain.md index 1eace93f61..dc43ae35bf 100644 --- a/skype/skype-ps/skype/Set-CsSipDomain.md +++ b/skype/skype-ps/skype/Set-CsSipDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cssipdomain +online version: https://learn.microsoft.com/powershell/module/skype/set-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSipDomain schema: 2.0.0 @@ -162,4 +162,3 @@ Instead, the cmdlet is used to modify existing instances of the Microsoft.Rtc.Ma [New-CsSipDomain](New-CsSipDomain.md) [Remove-CsSipDomain](Remove-CsSipDomain.md) - diff --git a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md index 666fbdc620..8709e8d4e9 100644 --- a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cssipresponsecodetranslationrule +online version: https://learn.microsoft.com/powershell/module/skype/set-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSipResponseCodeTranslationRule schema: 2.0.0 @@ -265,4 +265,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableC [New-CsSipResponseCodeTranslationRule](New-CsSipResponseCodeTranslationRule.md) [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsSite.md b/skype/skype-ps/skype/Set-CsSite.md index 7fbd7449fc..b5779296c3 100644 --- a/skype/skype-ps/skype/Set-CsSite.md +++ b/skype/skype-ps/skype/Set-CsSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cssite +online version: https://learn.microsoft.com/powershell/module/skype/set-cssite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSite schema: 2.0.0 @@ -251,4 +251,3 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Deploy.In ## RELATED LINKS [Get-CsSite](Get-CsSite.md) - diff --git a/skype/skype-ps/skype/Set-CsSlaConfiguration.md b/skype/skype-ps/skype/Set-CsSlaConfiguration.md index 6f9b77e7cd..17fb0a02a8 100644 --- a/skype/skype-ps/skype/Set-CsSlaConfiguration.md +++ b/skype/skype-ps/skype/Set-CsSlaConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csslaconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSlaConfiguration schema: 2.0.0 manager: rogupta @@ -224,7 +224,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsSlaConfiguration](https://docs.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) - -[Remove-CsSlaConfiguration](https://docs.microsoft.com/powershell/module/skype/remove-csslaconfiguration?view=skype-ps) +[Get-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration?view=skype-ps) +[Remove-CsSlaConfiguration](https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration?view=skype-ps) diff --git a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md b/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md index bfcd075c59..e573931e83 100644 --- a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csstaticroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsStaticRoutingConfiguration schema: 2.0.0 @@ -233,4 +233,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md b/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md index 23945d870f..e8dde2d1fe 100644 --- a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csstorageserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsStorageServiceConfiguration schema: 2.0.0 @@ -234,4 +234,3 @@ The `Set-CsStorageServiceConfiguration` cmdlet does not return any data or objec [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md deleted file mode 100644 index 901eda66e9..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsapppermissionpolicy -applicable: Skype for Business Online -title: Set-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# Set-CsTeamsAppPermissionPolicy - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsAppPermissionPolicy [-Tenant ] [-DefaultCatalogApps <>] [-GlobalCatalogApps <>] - [-PrivateCatalogApps <>] [-Description ] [-DefaultCatalogAppsType ] - [-GlobalCatalogAppsType ] [-PrivateCatalogAppsType ] [[-Identity] ] [-Force] - [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsAppPermissionPolicy [-Tenant ] [-DefaultCatalogApps <>] [-GlobalCatalogApps <>] - [-PrivateCatalogApps <>] [-Description ] [-DefaultCatalogAppsType ] - [-GlobalCatalogAppsType ] [-PrivateCatalogAppsType ] [-Instance ] [-Force] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally omitted. - -## 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 -``` - -### -DefaultCatalogApps -Do not use. - -```yaml -Type: -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultCatalogAppsType -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalCatalogApps -Do not use. - -```yaml -Type: -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalCatalogAppsType -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PrivateCatalogApps -Do not use. - -```yaml -Type: -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateCatalogAppsType -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md deleted file mode 100644 index 3c6b0f4502..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsappsetuppolicy -applicable: Skype for Business Online -title: Set-CsTeamsAppSetupPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsTeamsAppSetupPolicy - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsAppSetupPolicy [-Tenant ] [-PinnedAppBarApps <>] [-Description ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsAppSetupPolicy [-Tenant ] [-PinnedAppBarApps <>] [-Description ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. - -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 - -Intentionally not provided. - -## 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 -``` - -### -Description -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Do not use. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PinnedAppBarApps -Do not use. - -```yaml -Type: -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md deleted file mode 100644 index 6b40b395c8..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ /dev/null @@ -1,473 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamscallingpolicy -applicable: Microsoft Teams -title: Set-CsTeamsCallingPolicy -schema: 2.0.0 -manager: bulenteg -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# Set-CsTeamsCallingPolicy - -## SYNOPSIS -Use this cmdlet to update values in existing Teams Calling Policies. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsCallingPolicy [[-Identity] ] [-AllowCallForwardingToPhone ] [-AllowCallForwardingToUser ] [-AllowCallGroups ] -[-AllowCallRedirect ] [-AllowCloudRecordingForCalls ] [-AllowDelegation ] [-AllowPrivateCalling ] -[-AllowSIPDevicesCalling ] [-AllowTranscriptionForCalling ] [-AllowVoicemail ] [-AllowWebPSTNCalling ] -[-AutoAnswerEnabledType ] [-BusyOnBusyEnabledType ] [-CallRecordingExpirationDays ] [-Description ] -[-LiveCaptionsEnabledTypeForCalling ] [-MusicOnHoldEnabledType ] [-PopoutAppPathForIncomingPstnCalls ] [-PopoutForIncomingPstnCalls ] [-PreventTollBypass ] [-SpamFilteringEnabledType ] -[-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to set values in -a given Calling Policy instance. - -Only the parameters specified are changed. Other parameters keep their existing values. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-CsTeamsCallingPolicy -Identity Global -AllowPrivateCalling $true -``` - -Sets the value of the parameter AllowPrivateCalling in the Global (default) Teams Calling Policy instance. - -### Example 2 -``` -PS C:\> Set-CsTeamsCallingPolicy -Identity HRPolicy -LiveCaptionsEnabledTypeForCalling Disabled -``` - -Sets the value of the parameter LiveCaptionsEnabledTypeForCalling to Disabled in the Teams Calling Policy instance called HRPolicy. - -## PARAMETERS - -### -Identity -Name of the policy instance being modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallForwardingToPhone -Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallForwardingToUser -Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallGroups -Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCallRedirect -Setting this parameter provides the ability to configure call redirection capabilities on Teams phones. The valid options are: Enabled, Disabled, and UserOverride. When set to Enabled users will have the ability to redirect received calls. However, when set to Disabled the user will not have such ability. Note: The UserOverride option is not available for use. There's no UX implemented for its management. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCloudRecordingForCalls -Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDelegation -Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateCalling -Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. -If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSIPDevicesCalling -Determines whether the user is allowed to use SIP devices for calling on behalf of a Teams client. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTranscriptionForCalling -Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowVoicemail -Enables inbound calls to be routed to voicemail. Valid options are: AlwaysEnabled, AlwaysDisabled, and UserOverride. When set to AlwaysDisabled, calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams. When set to AlwaysEnabled, calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user. When set to UserOverride, calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowWebPSTNCalling -Allows PSTN calling from the Teams web client. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoAnswerEnabledType -Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams phones. It is turned off by default. Valid options are Enabled and Disabled. This setting applies only to incoming meeting invites and does not include support for other call types. - -```yaml -Type: Enum -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BusyOnBusyEnabledType -Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. Valid options are: Enabled, Unanswered, and Disabled. When set to Enabled, new or incoming calls will be rejected with a busy signal. When set to Unanswered, the user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. Note: The UserOverride option value is not available for use currently, if set it will be read as setting the value to Disabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CallRecordingExpirationDays -Sets the expiration of the recorded 1:1 calls. Default is 60 days. - -```yaml -Type: Long -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiveCaptionsEnabledTypeForCalling -Determines whether real-time captions are available for the user in Teams calls. Set this to DisabledUserOverride to allow users to turn on live captions. Set this to Disabled to prohibit. - -Possible values: -- DisabledUserOverride -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MusicOnHoldEnabledType -Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. It is turned on by default. Valid options are Enabled, Disabled, and UserOverride. For now, setting the value to UserOverride is the same as Enabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopoutAppPathForIncomingPstnCalls -Reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: "" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopoutForIncomingPstnCalls -Reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventTollBypass -Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. - -**Note**: Do not set this parameter to True for Calling Plan users as it will prevent successful call routing. This setting only works with Direct Routing that is configured to handle location based routing restrictions. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpamFilteringEnabledType -Determines Spam filtering mode. - -Possible values: -- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered as spam, the user will get a "Spam Likely" notification in Teams. -- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. -- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -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: Microsoft Teams - -Required: False -Position: Named -Default value: False -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: Microsoft Teams - -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). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) - -[Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) - -[Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) - -[New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md deleted file mode 100644 index d0d7c4af75..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsemergencycallingpolicy -applicable: Microsoft Teams -title: Set-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr -manager: roykuntz -ms.reviewer: chenc -schema: 2.0.0 ---- - -# Set-CsTeamsEmergencyCallingPolicy - -## SYNOPSIS - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsEmergencyCallingPolicy [[-Identity] ] [-Description ] [-EnhancedEmergencyServiceDisclaimer ] - [-ExternalLocationLookupMode ] [-NotificationDialOutNumber ] [-NotificationGroup ] [-NotificationMode ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet modifies an existing Teams Emergency Calling policy. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsTeamsEmergencyCallingPolicy -Identity "testECP" -NotificationGroup "123@gh.com;567@test.com" -``` - -This example modifies an existing cmdlet with identity testECP. - -## PARAMETERS - -### -Description -Provides a description of the Teams Emergency Calling policy to identify the purpose of setting it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnhancedEmergencyServiceDisclaimer -Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalLocationLookupMode -Enables ExternalLocationLookupMode. This mode allows users to set Emergency addresses for remote locations. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Disabled, Enabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter is a unique identifier that designates the name of the policy - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationDialOutNumber -This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationGroup -NotificationGroup is a email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance "group1@contoso.com;group2@contoso.com". A maximum of 50 users can be notified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationMode -The type of conference experience for security desk notification. Support for the ConferenceUnMuted mode is pending. - -```yaml -Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode -Parameter Sets: (All) -Aliases: -Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) - -[Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) - -[Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) - -[Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md deleted file mode 100644 index 81a57bcf7c..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ /dev/null @@ -1,1104 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsmeetingpolicy -applicable: Skype for Business Online -title: Set-CsTeamsMeetingPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsTeamsMeetingPolicy - -## SYNOPSIS -The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. - -## SYNTAX - -### Identity (Default) - -```powershell -Set-CsTeamsMeetingPolicy [-Tenant ] [-Description ] - [-AllowChannelMeetingScheduling ] [-AllowCartCaptionsScheduling ] [-LiveInterpretationEnabledType ] [-AllowMeetNow ] [-AllowPrivateMeetNow ] - [-MeetingChatEnabledType ] [-LiveCaptionsEnabledType ] [-AllowIPVideo ] [-IPAudioMode ] [-IPVideoMode ] - [-AllowAnonymousUsersToDialOut ] - [-AllowAnonymousUsersToJoinMeeting ] [-AllowAnonymousUsersToStartMeeting ] - [-BlockedAnonymousJoinClientTypes ] - [-AllowPrivateMeetingScheduling ] [-AutoAdmittedUsers ] [-AllowCloudRecording ] - [-AllowOutlookAddIn ] [-AllowPowerPointSharing ] - [-AllowParticipantGiveRequestControl ] [-AllowExternalParticipantGiveRequestControl ] - [-AllowSharedNotes ] [-AllowWhiteboard ] [-AllowTranscription ] - [-MediaBitRateKb ] [-RecordingStorageMode ] [-ScreenSharingMode ] [-AllowPSTNUsersToBypassLobby ] [-AllowRecordingStorageOutsideRegion ] - [-PreferredMeetingProviderForIslandsMode ] [[-Identity] ] - [-VideoFiltersMode ] [-AllowEngagementReport ] [-AllowNDIStreaming ] - [-DesignatedPresenterRoleMode ] [-AllowIPAudio ] [-AllowOrganizersToOverrideLobbySettings ] - [-AllowUserToJoinExternalMeeting ] [-EnrollUserOverride ] [-StreamingAttendeeMode ] -[-AllowBreakoutRooms ] [-TeamsCameraFarEndPTZMode ] [-AllowMeetingReactions ] -[-AllowMeetingRegistration ] [-AllowScreenContentDigitization ] [-AllowTrackingInReport ] [-RoomAttributeUserOverride ] -[-SpeakerAttributionMode ] [-WhoCanRegister ] [-ChannelRecordingDownload ] [-NewMeetingRecordingExpirationDays ] -[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] -[-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. - -The Set-CsTeamsMeetingPolicy cmdlet allows administrators to update existing meeting policies that can be assigned to particular users to control Teams features related to meetings. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Set-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True -``` - -The command shown in Example 1 uses the Set-CsTeamsMeetingPolicy cmdlet to update an existing meeting policy with the Identity SalesMeetingPolicy. -This policy will use all the existing values except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. - - -### EXAMPLE 2 - -```powershell -Set-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False -``` - -In Example 2, the Set-CsTeamsMeetingPolicy cmdlet is used to update a meeting policy with the Identity HrMeetingPolicy. -In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. -All other policy properties will use the existing values. - -### EXAMPLE 3 - -```powershell -Set-CsTeamsMeetingPolicy -Identity NonEVNetworkRoamingPolicy -AllowNetworkConfigurationSettingsLookup $True -``` - -In Example 3, the Set-CsTeamsMeetingPolicy cmdlet is used to update an existing meeting policy with the Identity NonEVNetworkRoamingPolicy. -This policy will use all the existing values except one: AllowNetworkConfigurationSettingsLookup; in this example, we will fetch network roaming policy for the non-EV user with NonEVNetworkRoamingPolicy based on his current network location. - -## PARAMETERS - -### -AllowAnonymousUsersToJoinMeeting - -> [!NOTE] -> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. - -Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymousUsersToStartMeeting -Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockedAnonymousJoinClientTypes -A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](/azure/communication-services/concepts/join-teams-meeting.md). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. - -The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Empty List -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowChannelMeetingScheduling -Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCloudRecording -Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowRecordingStorageOutsideRegion -Allow storing recording outside of region. All meeting recordings will be permanently stored in another region, and can't be migrated. For more info, see https://aka.ms/in-region. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowExternalParticipantGiveRequestControl -Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAudioMode -Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPVideoMode -Determines whether video can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming video in the meeting. Set this to DISABLED to prohibit outgoing and incoming video in the meeting. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCartCaptionsScheduling -Determines whether a user can add a URL for captions from a Communicatons Access Real-Time Translation (CART) captioner for providing real time captions in meetings. -Possible values are: -- **EnabledUserOverride**, CART captions is available by default but a user can disable. -- **DisabledUserOverride**, if you would like users to be able to use CART captions in meetings but by default it is disabled. -- **Disabled**, if you'd like to not allow CART captions in meeting. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: DisabledUserOverride -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiveInterpretationEnabledType -Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. -Possible values are: -- **DisabledUserOverride**, if you would like users to be able to use interpretation in meetings but by default it is disabled. -- **Disabled**, prevents the option to be enabled in Meeting Options. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: DisabledUserOverride -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOutlookAddIn -Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPowerPointSharing -Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. - -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSharedNotes -Determines whether users are allowed to take shared Meeting notes. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTranscription -Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowWhiteboard -Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -AutoAdmittedUsers -Determines what types of participants will automatically be added to meetings organized by this user. -Possible values are: -- **EveryoneInCompany**, if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. -- **EveryoneInSameAndFederatedCompany**, if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. -- **Everyone**, if you'd like to admit anonymous users by default. -- **OrganizerOnly**, if you would like that only meeting organizers can bypass the lobby. -- **EveryoneInCompanyExcludingGuests**, if you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately. -- **InvitedUsers**, if you would like that only meeting organizers and invited users can bypass the lobby. - -This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text about the meeting policy. -For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy being created. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScreenSharingMode -Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 -``` - -### -AllowPSTNUsersToBypassLobby -Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to **True**, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingChatEnabledType -Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPrivateMeetNow -This setting controls whether a user can start an ad hoc private meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAnonymousUsersToDialOut - -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out. - -> [!NOTE] -> This parameter is temporarily disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMeetingProviderForIslandsMode -Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TeamsAndSfb -Accept pipeline input: False -Accept wildcard characters: False -``` -### -RecordingStorageMode -This parameter can take two possible values: -- Stream -- OneDriveForBusiness - -Note: The change of storing Teams meeting recordings from Classic Stream to OneDrive and SharePoint (ODSP) has been completed as of August 30th, 2021. All recordings are now stored in ODSP. This change overrides the RecordingStorageMode parameter, and modifying the setting in PowerShell no longer has any impact. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiveCaptionsEnabledType -Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: DisabledUserOverride -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VideoFiltersMode -Determines the background effects that a user can configure in the Teams client. Possible values are: - -- NoFilters: No filters are available. -- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://docs.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). -- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. -- AllFilters: All filters are available, including custom images. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowEngagementReport -Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: - -- Enabled: allow the meeting organizer to download the report. -- Disabled: disable attendee report generation and prohibit meeting organizer from downloading it. - -If set to enabled, only meeting organizers will get a link to download the report in Teams. Regular attendees will have no access to it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowNDIStreaming -This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DesignatedPresenterRoleMode -Determines if users can change the default value of the _Who can present?_ setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings. - -Possible values are: -- EveryoneUserOverride: All meeting participants can be presenters. This is the default value. This parameter corresponds to the _Everyone_ setting in Teams. -- EveryoneInCompanyUserOverride: Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the _People in my organization_ setting in Teams. -- EveryoneInSameAndFederatedCompanyUserOverride: Authenticated users in the organization, including guest users and users from federated organizations, can be presenters. This parameter corresponds to the _People in my organization and trusted organizations_ setting in Teams. -- OrganizerOnlyUserOverride: Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the _Only me_ setting in Teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VideoFiltersMode -Determines what background effects a user can use in scheduled calls and meetings. -Possible values: NoFilters, BlurOnly, BlurAndDefaultBackgrounds, AllFilters. - -```yaml -Type: Enum -Position: Named -Default value: AllFilters -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowIPAudio -Determines whether audio is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their audio. Set this to FALSE to prohibit the user from sharing their audio. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOrganizersToOverrideLobbySettings -This parameter has been deprecated and currently has no effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserToJoinExternalMeeting -Currently, this parameter has no effect. - -Possible values are: -- Enabled -- FederatedOnly -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnrollUserOverride -Possible values are: -- Disabled -- Enabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreamingAttendeeMode - -Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality). - -Possible values are: -- Disabled -- Enabled - -Set this to Enabled to allow up to 20,000 extra view-only attendees to join. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowBreakoutRooms -Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamsCameraFarEndPTZMode -Possible values are: -- Disabled -- AutoAcceptInTenant -- AutoAcceptAll - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingReactions -Set to false to disable Meeting Reactions. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMeetingRegistration -Controls if a user can create a webinar meeting. The default value is True. - -Possible values: -- True -- False - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowScreenContentDigitization -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTrackingInReport -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoomAttributeUserOverride -Possible values: - -- Off -- Distinguish -- Attribute - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpeakerAttributionMode -Possible values: - -- EnabledUserOverride -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhoCanRegister -Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts set the value to 'EveryoneInCompany'. - -Possible values: - -- Everyone -- EveryoneInCompany - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewMeetingRecordingExpirationDays -Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. Value can also be -1 to set meeting recordings to never expire. - -NOTE: You may opt to set Meeting Recordings to never expire by entering the value -1. - -NOTE: This parameter is available to be set, but will not be effective until this feature gets general availability. Please refer to the [roadmap (Feature ID: 84580)](https://www.microsoft.com/microsoft-365/roadmap?filters=&searchterms=84580) for more information on its delivery date. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MeetingInviteLanguages -Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. -Note: All Teams supported languages can be specified using language codes. For more information about its delivery date, see the [roadmap (Feature ID: 81521)](https://www.microsoft.com/en-us/microsoft-365/roadmap?filters=&searchterms=81521). - -The preliminary list of available languages is shown below: -ar-SA,az-Latn-AZ,bg-BG,ca-ES,cs-CZ,cy-GB,da-DK,de-DE,el-GR,en-GB,en-US,es-ES,es-MX,et-EE,eu-ES,fi-FI,fil-PH,fr-CA,fr-FR,gl-ES,he-IL,hi-IN,hr-HR,hu-HU,id-ID,is-IS,it-IT,ja-JP,ka-GE,kk-KZ,ko-KR,lt-LT,lv-LV,mk-MK,ms-MY,nb-NO,nl-NL,nn-NO,pl-PL,pt-BR,pt-PT,ro-RO,ru-RU,sk-SK,sl-SL,sq-AL,sr-Latn-RS,sv-SE,th-TH,tr-TR,uk-UA,vi-VN,zh-CN,zh-TW. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelRecordingDownload -Controls how channel meeting recordings are saved, permissioned, and who can download them. - -Possible values: - -- Allow - Saves channel meeting recordings to a "Recordings" folder in the channel. The permissions on the recording files will be based on the Channel SharePoint permissions. This is the same as any other file uploaded for the channel. -- Block - Saves channel meeting recordings to a "Recordings\View only" folder in the channel. Channel owners will have full rights to the recordings in this folder, but channel members will have read access without the ability to download. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Allow -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowNetworkConfigurationSettingsLookup -Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiveStreamingMode -Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP). - -Possible values are: -- Disabled -- Enabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md deleted file mode 100644 index 3c29045867..0000000000 --- a/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md +++ /dev/null @@ -1,468 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsmessagingpolicy -applicable: Skype for Business Online -title: Set-CsTeamsMessagingPolicy -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsTeamsMessagingPolicy - -## SYNOPSIS -The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsMessagingPolicy [-Tenant ] [-Description ] [-AllowUrlPreviews ] - [-AllowOwnerDeleteMessage ] [-AllowUserEditMessage ] [-AllowUserDeleteMessage ] - [-AllowUserChat ] [-AllowGiphy ] [-GiphyRatingType ] [-AllowMemes ] - [-AllowStickers ] [-AllowUserTranslation ] [-AllowImmersiveReader ] - [-AllowRemoveUser ] [-AllowPriorityMessages ] [-AllowSmartReply ] [-Allow [-ReadReceiptsEnabledType ] - [-AudioMessageEnabledType ] [-ChannelsInChatListEnabledType ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] [-ChatPermissionRole ] -``` - -### Instance -``` -Set-CsTeamsMessagingPolicy [-Tenant ] [-Description ] [-AllowUrlPreviews ] - [-AllowOwnerDeleteMessage ] [-AllowUserEditMessage ] [-AllowUserDeleteMessage ] - [-AllowUserChat ] [-AllowGiphy ] [-GiphyRatingType ] [-AllowMemes ] - [-AllowStickers ] [-AllowUserTranslation ] [-AllowImmersiveReader ] - [-AllowRemoveUser ] [-AllowPriorityMessages ] [-AllowSmartReply ] [-ReadReceiptsEnabledType ] - [-AudioMessageEnabledType ] [-ChannelsInChatListEnabledType ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet updates a Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. - - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Set-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false -``` - -In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. -All other policy properties will be left as previously assigned. - -### Example 2 - -```powershell -PS C:\> Get-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy | Set-CsTeamsMessagingPolicy -AllowGiphy $false -AllowMemes $false -``` - -In this example two different property values are configured for all teams messaging policies in the organization: AllowGiphy is set to false and AllowMemes is set to False. -All other policy properties will be left as previously assigned. - - -## PARAMETERS - -### -AllowGiphy -Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit. -Note: [Optional Connected Experiences](https://docs.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for Giphys to be allowed. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowImmersiveReader -Determines whether a user is allowed to use Immersive Reader for reading conversation messages. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowMemes -Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowOwnerDeleteMessage -Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPriorityMessages -Determines whether a user is allowed to send priorities messages. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowSmartReply -Turn this setting on to enable suggested replies for chat messages. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowRemoveUser -Determines whether a user is allowed to remove a user from a conversation. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowStickers -Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserChat -Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserDeleteMessage -Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. -If this value is set to FALSE, the team owner will not be able to delete their own messages. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserEditMessage -Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUserTranslation -Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUrlPreviews -Use this setting to turn automatic URL previewing on or off in messages. Set this to TRUE to turn on. Set this to FALSE to turn off. -Note: [Optional Connected Experiences](https://docs.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for URL previews to be allowed. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AudioMessageEnabledType -Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels, ChatsOnly, Disabled. - -```yaml -Type: AudioMessageEnabledTypeEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChannelsInChatListEnabledType -On mobile devices, enable to display favorite channels above recent chats. - -Possible values are: DisabledUserOverride, EnabledUserOverride. - -```yaml -Type: ChannelsInChatListEnabledTypeEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of your policy to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GiphyRatingType -Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity TeamsMessagingPolicy. - -If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadReceiptsEnabledType -Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 -``` - -### -ChatPermissionRole -Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the enviornment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. - -```yaml -Type: String -Position: Named -Default value: Restricted -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.Automation.PSObject - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md index f3ce016ac1..c8556d260f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsupgradeconfiguration -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradeconfiguration +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTeamsUpgradeConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsUpgradeConfiguration @@ -180,4 +180,4 @@ These settings are only honored by newer versions of Skype for Business clients. [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md index 4467e0d429..86e0f3e376 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md @@ -1,8 +1,8 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsupgradepolicy -applicable: Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradepolicy +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTeamsUpgradePolicy schema: 2.0.0 manager: rogupta @@ -138,7 +138,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://docs.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) diff --git a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md b/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md index 293d9624df..8a7a2ec48f 100644 --- a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstelemetryconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTelemetryConfiguration schema: 2.0.0 @@ -170,4 +170,3 @@ None ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTenantDialPlan.md b/skype/skype-ps/skype/Set-CsTenantDialPlan.md deleted file mode 100644 index 93782d3603..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantDialPlan.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantdialplan -applicable: Skype for Business Online -title: Set-CsTenantDialPlan -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsTenantDialPlan - -## SYNOPSIS -Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTenantDialPlan [-Tenant ] [-Description ] [-NormalizationRules ] - [-ExternalAccessPrefix ] [-SimpleName ] [-OptimizeDeviceDialing ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTenantDialPlan [-Tenant ] [-Description ] [-NormalizationRules ] - [-ExternalAccessPrefix ] [-SimpleName ] [-OptimizeDeviceDialing ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The `Set-CsTenantDialPlan` cmdlet modifies an existing tenant dial plan. -Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. -The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. - -Although normalization rules of a tenant dial plan can be added by using this cmdlet, it is recommended that you use the [New-CsVoiceNormalizationRule](https://docs.microsoft.com/powershell/module/skype/New-CsVoiceNormalizationRule) cmdlet instead. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9 -``` - -This example updates the vt1tenantDialPlan9 tenant dial plan to use an external access prefix of 123. - - -### -------------------------- Example 2 -------------------------- -``` -$nr2 = Get-CsVoiceNormalizationRule -Identity "US/US Long Distance" - -Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9 -NormalizationRules @{Add=$nr2} -``` - -This example updates the vt1tenantDialPlan9 tenant dial plan to have an external access prefix of 123 and use the US/US Long Distance normalization rules. - - -### -------------------------- Example 3 -------------------------- -``` -$DP = Get-CsTenantDialPlan -Identity Global -$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit") -$NR.Name = "RedmondRule" -Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRules -``` - -This example changes the name of an normalization rule. -Keep in mind that changing the name also changes the name portion of the Identity. -The `Set-CsVoiceNormalizationRule` cmdlet doesn't have a Name parameter, so in order to change the name, we first call the `Get-CsTenantDialPlan` cmdlet to retrieve the Dial Plan with the Identity Global and assign the returned object to the variable $DP. Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign the returned object to the variable $NR. -We then assign the string RedmondRule to the Name property of the object. -Finally, we pass the variable back to the NormalizationRules parameter of the `Set-CsTenantDialPlan` cmdlet to make the change permanent. - - -### -------------------------- Example 4 -------------------------- -``` -$DP = Get-CsTenantDialPlan -Identity Global -$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit") -$DP.NormalizationRules.Remove($NR) -Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRules -``` - -This example removes a normalization rule. -We utilize the same functionality as for Example 3 to manipulate the Normalization Rule Object and update it with the `Set-CsTenantDialPlan` cmdlet. -We first call the `Get-CsTenantDialPlan` cmdlet to retrieve the Dial Plan with the Identity Global and assign the returned object to the variable $DP. Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign it to the variable $NR. Next, we remove this Object with the Remove Method from $DP.NormalizationRules. -Finally, we pass the variable back to the NormalizationRules parameter of the `Set-CsTenantDialPlan` cmdlet to make the change permanent. - - -## PARAMETERS - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. -Maximum characters is 1040. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccessPrefix -The ExternalAccessPrefix parameter is a number (or set of numbers) that designates the call as external to the organization. -(For example, to tenant-dial an outside line, first dial 9). This prefix is ignored by the normalization rules, although these rules will be applied to the rest of the number. -The OptimizeDeviceDialing parameter must be set to True for this value to take effect. - -The value of this parameter must be no longer than 4 characters long and can contain only digits, "#" or a "*". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantDialPlan` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NormalizationRules -The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://docs.microsoft.com/powershell/module/skype/New-CsVoiceNormalizationRule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. - -The number of normalization rules cannot exceed 50 per TenantDialPlan. - -```yaml -Type: List -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptimizeDeviceDialing -Use this parameter to determine the effect of ExternalAccessPrefix parameter. -If set to True, the ExternalAccessPrefix parameter takes effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SimpleName -The SimpleName parameter is a display name for the tenant dial plan. -This name must be unique among all tenant dial plans. - -This string can be up to 49 characters long. -Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md b/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md index 001a28ccd7..ca249562b2 100644 --- a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenanthybridconfiguration -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/set-cstenanthybridconfiguration +applicable: Skype for Business Server 2019 title: Set-CsTenantHybridConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTenantHybridConfiguration @@ -261,4 +261,3 @@ None. ## RELATED LINKS [Get-CsTenantHybridConfiguration](Get-CsTenantHybridConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md b/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md deleted file mode 100644 index 10e74271af..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantnetworkregion -applicable: Skype for Business Online -title: Set-CsTenantNetworkRegion -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsTenantNetworkRegion - -## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region, and has no dependencies or restrictions. Tenant network region is used for Location Based Routing. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTenantNetworkRegion [-Tenant ] [-Description ] [-NetworkRegionID ] - [-CentralSite ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### Instance -``` -Set-CsTenantNetworkRegion [-Tenant ] [-Description ] [-NetworkRegionID ] - [-CentralSite ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. - -## EXAMPLES - -###-------------------------- Example 1 -------------------------- -```powershell -PS C:\> Set-CsTenantNetworkRegion -Identity "RegionA" -Description "Region A" -``` - -The command shown in Example 1 set the network region 'RegionA' with description 'Region A'. - -###-------------------------- Example 2 -------------------------- -```powershell -PS C:\> Set-CsTenantNetworkRegion -Identity "RegionRedmond" -Description "Redmond region" -CentralSite "Central site 1" -``` - -The command shown in Example 2 set the network region 'RegionRedmond' with description 'Redmond region'. CentralSite is set to "Central site 1". - -Previously in Skype for Business there was an additional required parameter `-CentralSite `, however it is now optional. - -## PARAMETERS - -### -CentralSite -This parameter is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of the network region to identify purpose of setting it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the network region to be set. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantNetworkRegion` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkRegionID -The name of the network region. Not required in this PowerShell command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network regions are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTenantPublicProvider.md b/skype/skype-ps/skype/Set-CsTenantPublicProvider.md deleted file mode 100644 index 49ace4e21a..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantPublicProvider.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantpublicprovider -applicable: Skype for Business Online -title: Set-CsTenantPublicProvider -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Set-CsTenantPublicProvider - -## SYNOPSIS -Enables and disables communication with the third-party IM and presence providers Windows Live, AOL, and Yahoo. -When enabled, Skype for Business Online users will be able to exchange IM and presence information with users who have accounts on the specified public provider. - -## SYNTAX - -``` -Set-CsTenantPublicProvider [-Provider ] [-Tenant ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Public providers are organizations that provide SIP communication services for the general public. -When you establish a federation relationship with a public provider, you effectively establish federation with any user who has an account hosted by that provider. -For example, if you federate with Windows Live, then your users will be able to exchange instant messages and presence information with anyone who has a Windows Live instant messaging account. - -Skype for Business Online gives administrators the option of configuring federation with one or more of the following public IM and presence providers: - -Windows Live - -AOL - -Yahoo! - -The `Set-CsTenantPublicProvider` cmdlet can be used to enable or disable federation with any of these public providers. -When using this cmdlet, keep in mind that each time you run the `Set-CsTenantPublicProvider` cmdlet you must specify all of the providers that should be enabled. -For example, suppose all three providers are disabled and you run this command: - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "WindowsLive"` - -As you might expect, that will enable Windows Live, and will leave AOL and Yahoo disabled. - -Now, suppose you next run this command: - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "AOL"` - -That command will enable AOL. -However, it will also disable Windows Live: that's because Windows Live was not specified as part of the parameter value supplied to the Provider parameter. -If you want to enable AOL and keep Windows Live enabled as well, then you must specify both AOL and Windows Live when calling Set-CsTenantPublicProvider: - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "AOL","WindowsLive"` - -To disable federation for all three providers, set the Provider property to an empty string (""): - -`Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider ""` - -Note that simply enabling the status of a public provider does not mean that users can exchange instant messages and presence information with users who have accounts on that provider. -In addition to enabling federation with the provider itself, administrators must also set the AllowPublicUsers property of the federation configuration settings to True. -If this property is set to False then communication will not be allowed with any of the public providers, regardless of the public provider configuration settings. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "WindowsLive" -``` - -The command shown in Example 1 enables federation with Windows Live for the tenant with the tenant ID bf19b7db-6960-41e5-a139-2aa373474354. -Because Windows Live is the only provider specified, both the AOL and Yahoo providers will be disabled after the command executes. - - -### -------------------------- Example 2 -------------------------- -``` -Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "WindowsLive","AOL" -``` - -In Example 2, two public providers are enabled: Windows Live and AOL. -That means that only the Yahoo public provider will be disabled for the specified tenant. - - -### -------------------------- Example 3 -------------------------- -``` -Set-CsTenantPublicProvider -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Provider "" -``` - -Example 3 shows how you can disable all the public providers for a given tenant. -This is done by setting the Provider property to an empty string (""). - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Provider -Indicates the public provider (or providers) that users will be allowed to communicate with. -Valid values are: - -* AOL -* WindowsLive -* Yahoo - -Note that, when configuring public providers, any provider included in the Provider parameter value will be enabled for use, while any provider not included in the parameter value will be disabled. -For example, this syntax enables only Yahoo, while disabling Windows Live and AOL: - -`-Provider "Yahoo"` - -You can enable multiple providers by separating the provider names by using commas: - -`-Provider "AOL","WindowsLive"` - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose public provider settings are being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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 - -### -The `Set-CsTenantPublicProvider` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Hosted.TenantPICStatus object. - -## OUTPUTS - -### -None. -Instead, the `Set-CsTenantPublicProvider` cmdlet modifies existing instances of the Microsoft.Rtc.Management.Hosted.TenantPICStatus object. - -## NOTES - -## RELATED LINKS - -[Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) - -[Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) - diff --git a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md index 401f8381b9..16213f56b6 100644 --- a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantupdatetimewindow +online version: https://learn.microsoft.com/powershell/module/skype/set-cstenantupdatetimewindow applicable: Skype for Business Online title: Set-CsTenantUpdateTimeWindow schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTenantUpdateTimeWindow @@ -344,4 +344,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTestDevice.md b/skype/skype-ps/skype/Set-CsTestDevice.md index d5cac0e6b3..47708627fc 100644 --- a/skype/skype-ps/skype/Set-CsTestDevice.md +++ b/skype/skype-ps/skype/Set-CsTestDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstestdevice +online version: https://learn.microsoft.com/powershell/module/skype/set-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTestDevice schema: 2.0.0 @@ -224,4 +224,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsTestDevice](New-CsTestDevice.md) [Remove-CsTestDevice](Remove-CsTestDevice.md) - diff --git a/skype/skype-ps/skype/Set-CsTestUserCredential.md b/skype/skype-ps/skype/Set-CsTestUserCredential.md index c48ce93af0..35ebd6a75a 100644 --- a/skype/skype-ps/skype/Set-CsTestUserCredential.md +++ b/skype/skype-ps/skype/Set-CsTestUserCredential.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstestusercredential +online version: https://learn.microsoft.com/powershell/module/skype/set-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTestUserCredential schema: 2.0.0 @@ -230,4 +230,3 @@ Instead, the `Set-CsTestUserCredential` cmdlet modifies existing instances of th [Get-CsTestUserCredential](Get-CsTestUserCredential.md) [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) - diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md index f36891e93d..8ceafe90ca 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystem +online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsThirdPartyVideoSystem schema: 2.0.0 @@ -247,4 +247,3 @@ However, if you include the PassThru parameter the cmdlet will pass instances of [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) - diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md index a8d6723831..c59e5e1f93 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystempolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsThirdPartyVideoSystemPolicy schema: 2.0.0 @@ -225,4 +225,3 @@ Instead, the `Set-CsThirdPartyVideoSystemPolicy` cmdlet modifies existing instan [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md b/skype/skype-ps/skype/Set-CsTrunkConfiguration.md index 3a0454acd5..d679673e79 100644 --- a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTrunkConfiguration schema: 2.0.0 @@ -765,4 +765,3 @@ This cmdlet does not return a value; it modifies an object of type Microsoft.Rtc [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) - diff --git a/skype/skype-ps/skype/Set-CsTrustedApplication.md b/skype/skype-ps/skype/Set-CsTrustedApplication.md index 3d905b3c39..5decd88312 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplication.md +++ b/skype/skype-ps/skype/Set-CsTrustedApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstrustedapplication +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTrustedApplication schema: 2.0.0 @@ -156,4 +156,3 @@ It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplica [Remove-CsTrustedApplication](Remove-CsTrustedApplication.md) [Get-CsTrustedApplication](Get-CsTrustedApplication.md) - diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md b/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md index 0c587c5c33..505d5b29a7 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstrustedapplicationendpoint +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTrustedApplicationEndpoint schema: 2.0.0 @@ -341,4 +341,3 @@ It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApp [Remove-CsTrustedApplicationEndpoint](Remove-CsTrustedApplicationEndpoint.md) [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) - diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md b/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md index 4309a1f09e..aa6bd0be59 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md +++ b/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstrustedapplicationpool +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTrustedApplicationPool schema: 2.0.0 @@ -325,4 +325,3 @@ It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) - diff --git a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md index 971e7a940c..5a7d9ecb84 100644 --- a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csucphoneconfiguration -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csucphoneconfiguration +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUCPhoneConfiguration schema: 2.0.0 manager: bulenteg @@ -413,4 +413,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsUCPhoneConfiguration](New-CsUCPhoneConfiguration.md) [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsUICulture.md b/skype/skype-ps/skype/Set-CsUICulture.md index 8caeaae3b9..e596429fed 100644 --- a/skype/skype-ps/skype/Set-CsUICulture.md +++ b/skype/skype-ps/skype/Set-CsUICulture.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuiculture +online version: https://learn.microsoft.com/powershell/module/skype/set-csuiculture applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUICulture schema: 2.0.0 @@ -136,4 +136,3 @@ Instead, the cmdlet modifies existing instances of the System.Globalization.Cult ## RELATED LINKS [Get-CsUICulture](Get-CsUICulture.md) - diff --git a/skype/skype-ps/skype/Set-CsUnassignedNumber.md b/skype/skype-ps/skype/Set-CsUnassignedNumber.md index 8111a9ccf5..404dd230e4 100644 --- a/skype/skype-ps/skype/Set-CsUnassignedNumber.md +++ b/skype/skype-ps/skype/Set-CsUnassignedNumber.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csunassignednumber +online version: https://learn.microsoft.com/powershell/module/skype/set-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUnassignedNumber schema: 2.0.0 @@ -311,4 +311,3 @@ It modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnno [Get-CsAnnouncement](Get-CsAnnouncement.md) [Get-CsExUmContact](Get-CsExUmContact.md) - diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index 12c49829f5..6578b30a14 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/skype/Set-CsUser.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuser -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csuser +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUser schema: 2.0.0 manager: bulenteg @@ -17,7 +17,7 @@ Modifies Skype for Business properties for an existing user account. Properties can be modified only for accounts that have been enabled for use with Skype for Business. This cmdlet was introduced in Lync Server 2010. -**Note**: Using this cmdlet for Microsoft Teams users will be deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. The new cmdlets are currently not supported for customers and tenants that are or have been enabled for Regionally Hosted Meetings for Skype for Business Online. These customers should continue to use Set-CsUser. +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -31,7 +31,7 @@ Set-CsUser [-DomainController ] [-Identity] [-PassThru] ``` ## DESCRIPTION -The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Azure Active Directory. +The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Microsoft Entra ID. For example, you can disable or re-enable a user for Skype for Business Server; enable or disable a user for audio/video (A/V) communications; or modify a user's private line and line URI numbers. For Skype for Business online enable or disable a user for enterprise voice, hosted voicemail, or modify the user's on premise line uri. The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business. @@ -156,7 +156,7 @@ Accept wildcard characters: False Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. -**Note**: Using this parameter for Microsoft Teams users will be deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml Type: Boolean @@ -175,7 +175,7 @@ Accept wildcard characters: False When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. -**Note**: Using this parameter will be deprecated for Teams users and it is not required anymore to set it for Microsoft Teams users. +**Note**: It is not required to set this parameter for Microsoft Teams users. Using this parameter has been deprecated for Microsoft Teams users in commercial and GCC cloud instances. ```yaml Type: Boolean @@ -191,24 +191,26 @@ Accept wildcard characters: False ``` ### -LineURI -Phone number assigned to the user. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. - -It is important to note that Skype for Business Server treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not be flagged as a duplicate number. -This is due to the fact that, depending on your setup, those two numbers could actually be different. -For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. -Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. -Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension TEL:+14255551297;ext=51297 +For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. + +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -241,8 +243,8 @@ A private line is a phone number that is not published in Active Directory Domai In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. -The private line value should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. ```yaml Type: String @@ -392,17 +394,19 @@ Accept wildcard characters: False ### -OnPremLineURI Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -Note that Skype for Business treats TEL:+14255551297 and TEL:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI TEL:+14255551297 and later try to assign Pilar Ackerman the line URI TEL:+14255551297;ext=51297, that assignment will succeed. +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. Depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. -**Note**: Using this parameter for Microsoft Teams users will be deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. ```yaml Type: String @@ -444,4 +448,3 @@ The `Set-CsUser` cmdlet does not return any objects. [Move-CsUser](Move-CsUser.md) -[Get-CsOnlineUser](Get-CsOnlineUser.md) diff --git a/skype/skype-ps/skype/Set-CsUserAcp.md b/skype/skype-ps/skype/Set-CsUserAcp.md index 227e1ad41c..e79059fc9a 100644 --- a/skype/skype-ps/skype/Set-CsUserAcp.md +++ b/skype/skype-ps/skype/Set-CsUserAcp.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuseracp -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/set-csuseracp +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserAcp schema: 2.0.0 manager: bulenteg @@ -26,7 +26,7 @@ Set-CsUserAcp [-Identity] -Domain -Name -Par ``` ## DESCRIPTION -Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://docs.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. +Deprecation Notice: Integration of Skype for Business with third-party audio conferencing providers has been retired. More details are here - https://learn.microsoft.com/skypeforbusiness/legal-and-regulatory/end-of-integration-with-3rd-party-providers. As a result, cmdlet no longer works. An audio conferencing provider is a third-party company that provides organizations with conferencing services. Among other things, audio conferencing providers offer a way for users located off site and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or meeting. @@ -324,4 +324,3 @@ None. [Get-CsUserAcp](Get-CsUserAcp.md) [Remove-CsUserAcp](Remove-CsUserAcp.md) - diff --git a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md b/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md index c3465e5b1d..1c371c4113 100644 --- a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csusercallforwardingsettings +online version: https://learn.microsoft.com/powershell/module/skype/set-csusercallforwardingsettings applicable: Skype for Business Server 2019 title: Set-CsUserCallForwardingSettings schema: 2.0.0 diff --git a/skype/skype-ps/skype/Set-CsUserDatabaseState.md b/skype/skype-ps/skype/Set-CsUserDatabaseState.md index ed0e505571..457fd92a5b 100644 --- a/skype/skype-ps/skype/Set-CsUserDatabaseState.md +++ b/skype/skype-ps/skype/Set-CsUserDatabaseState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserdatabasestate +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdatabasestate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserDatabaseState schema: 2.0.0 @@ -207,4 +207,3 @@ Instead, the `Set-CsUserDatabaseState` cmdlet modifies existing instances of the [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) [Update-CsUserDatabase](Update-CsUserDatabase.md) - diff --git a/skype/skype-ps/skype/Set-CsUserDelegates.md b/skype/skype-ps/skype/Set-CsUserDelegates.md index daff526c27..51ab7a0a53 100644 --- a/skype/skype-ps/skype/Set-CsUserDelegates.md +++ b/skype/skype-ps/skype/Set-CsUserDelegates.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserdelegates +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdelegates applicable: Skype for Business Server 2019 title: Set-CsUserDelegates schema: 2.0.0 @@ -13,7 +13,7 @@ ms.reviewer: # Set-CsUserDelegates ## SYNOPSIS -Used to modify an user's delegates list. +Used to modify a user's delegates list. ## SYNTAX @@ -23,7 +23,7 @@ Set-CsUserDelegates -Delegates [-User] ``` ## DESCRIPTION -The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: CsAdministrator - Get and Set for all cmdlets, CsVoiceAdministrator - Get and Set for all cmdlets, CsServerAdministrator - Get and Set for all cmdlets, CsHelpDesk - Get for all cmdlets Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. For more information see [Using SEFAUtil functionality via PowerShell in Skype for Business Server 2019](https://docs.microsoft.com/skypeforbusiness/sefautil-functionality). +The feature enables the use of SEFAUtil functionality in PowerShell. SEFAUtil (Secondary Extension Feature Activation) enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: CsAdministrator - Get and Set for all cmdlets, CsVoiceAdministrator - Get and Set for all cmdlets, CsServerAdministrator - Get and Set for all cmdlets, CsHelpDesk - Get for all cmdlets Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. For more information see [Using SEFAUtil functionality via PowerShell in Skype for Business Server 2019](https://learn.microsoft.com/skypeforbusiness/sefautil-functionality). ## EXAMPLES diff --git a/skype/skype-ps/skype/Set-CsUserPstnSettings.md b/skype/skype-ps/skype/Set-CsUserPstnSettings.md index 6da2cccd70..92e36241ea 100644 --- a/skype/skype-ps/skype/Set-CsUserPstnSettings.md +++ b/skype/skype-ps/skype/Set-CsUserPstnSettings.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserpstnsettings +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserpstnsettings applicable: Skype for Business Online title: Set-CsUserPstnSettings schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsUserPstnSettings @@ -174,4 +174,3 @@ The `Set-CsUserPstnSettings` cmdlet returns instances of the UserPstnSettings ob ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md b/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md index f46a0315aa..55e92367ce 100644 --- a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserreplicatorconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserReplicatorConfiguration schema: 2.0.0 @@ -290,4 +290,3 @@ Instead, the cmdlet modifies the global instance (the only such instance) of the [New-CsUserReplicatorConfiguration](New-CsUserReplicatorConfiguration.md) [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsUserServer.md b/skype/skype-ps/skype/Set-CsUserServer.md index e98058b0ab..5e4b1ca974 100644 --- a/skype/skype-ps/skype/Set-CsUserServer.md +++ b/skype/skype-ps/skype/Set-CsUserServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserserver +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserServer schema: 2.0.0 @@ -250,4 +250,3 @@ Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management. ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md b/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md index 3e98288aa5..e84ea92d4a 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md +++ b/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserservicesconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserServicesConfiguration schema: 2.0.0 @@ -459,4 +459,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [New-CsUserServicesConfiguration](New-CsUserServicesConfiguration.md) [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md b/skype/skype-ps/skype/Set-CsUserServicesPolicy.md index 39dc59ed63..b616c7d545 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md +++ b/skype/skype-ps/skype/Set-CsUserServicesPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserservicespolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsUserServicesPolicy schema: 2.0.0 @@ -281,4 +281,3 @@ Instead, the `Set-CsUserServicesPolicy` cmdlet modifies existing instances of th [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsUserTeamMembers.md b/skype/skype-ps/skype/Set-CsUserTeamMembers.md index 1b7dda22fb..ec4147db30 100644 --- a/skype/skype-ps/skype/Set-CsUserTeamMembers.md +++ b/skype/skype-ps/skype/Set-CsUserTeamMembers.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csuserteammembers +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserteammembers applicable: Skype for Business Server 2019 title: Set-CsUserTeamMembers schema: 2.0.0 @@ -13,7 +13,7 @@ ms.reviewer: # Set-CsUserTeamMembers ## SYNOPSIS -Used to modify an user's team members list. +Used to modify a user's team members list. ## SYNTAX @@ -23,7 +23,7 @@ Set-CsUserTeamMembers -Team [-User] ``` ## DESCRIPTION -The feature enables the use of SEFAUtil (Secondary Extension Feature Activation) functionality in PowerShell. SEFAUtil enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: CsAdministrator - Get and Set for all cmdlets, CsVoiceAdministrator - Get and Set for all cmdlets, CsServerAdministrator - Get and Set for all cmdlets, CsHelpDesk - Get for all cmdlets Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. For more information see [Using SEFAUtil functionality via PowerShell in Skype for Business Server 2019](https://docs.microsoft.com/skypeforbusiness/sefautil-functionality). +The feature enables the use of SEFAUtil (Secondary Extension Feature Activation) functionality in PowerShell. SEFAUtil enables Skype server administrators and helpdesk agents to configure delegate-ringing, call-forwarding and Group Call Pickup settings on behalf of a Skype server user. This tool also allows administrators to query the call-routing settings that are published for a particular user. The cmdlets introduced in this feature can only be run by members of the following groups for On-prem deployments, per the access level specified below: CsAdministrator - Get and Set for all cmdlets, CsVoiceAdministrator - Get and Set for all cmdlets, CsServerAdministrator - Get and Set for all cmdlets, CsHelpDesk - Get for all cmdlets Server auto-discovery needs to be enabled. There are no additional licensing requirements for use of the cmdlets. For more information see [Using SEFAUtil functionality via PowerShell in Skype for Business Server 2019](https://learn.microsoft.com/skypeforbusiness/sefautil-functionality). ## EXAMPLES diff --git a/skype/skype-ps/skype/Set-CsVideoGateway.md b/skype/skype-ps/skype/Set-CsVideoGateway.md index ed9b6768a1..166e402503 100644 --- a/skype/skype-ps/skype/Set-CsVideoGateway.md +++ b/skype/skype-ps/skype/Set-CsVideoGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvideogateway +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideogateway applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVideoGateway schema: 2.0.0 @@ -191,4 +191,3 @@ The `Set-CsVideoGateway` cmdlet does not return any objects or values. ## RELATED LINKS [Get-CsVideoTrunk](Get-CsVideoTrunk.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServer.md b/skype/skype-ps/skype/Set-CsVideoInteropServer.md index 2a9250a899..206a48e916 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServer.md +++ b/skype/skype-ps/skype/Set-CsVideoInteropServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvideointeropserver +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserver applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVideoInteropServer schema: 2.0.0 @@ -301,4 +301,3 @@ The `Set-CsVideoInteropServer` cmdlet does not return any objects or values. [Set-CsVideoGateway](Set-CsVideoGateway.md) [Get-CsVideoTrunk](Get-CsVideoTrunk.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md b/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md index f0b550fb86..80989a190d 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvideointeropserverconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVideoInteropServerConfiguration schema: 2.0.0 @@ -205,4 +205,3 @@ The `Set-CsVideoInteropServerConfiguration` cmdlet modifies existing instances o [New-CsVideoInteropServerConfiguration](New-CsVideoInteropServerConfiguration.md) [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md index 0788048bdd..05da2f52c4 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvideointeropserversynthetictransactionconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVideoInteropServerSyntheticTransactionConfiguration schema: 2.0.0 @@ -182,4 +182,3 @@ None. [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) - diff --git a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md index 7e3c9b5afb..32c668c947 100644 --- a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvideotrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVideoTrunkConfiguration schema: 2.0.0 @@ -39,7 +39,7 @@ The Video Interop Server is a Skype service that runs on a standalone pool and c To enable the Video Interop Server, you must use Topology Builder to define at least one VIS instance. Each VIS instance will typically be associated with one or more Video Gateways. -Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from an third party PBX supporting 3rd party video teleconferencing systems (VTCs). +Video Gateways route traffic between internal and third party video devices such as an internal Skype endpoint receiving video from a third party PBX supporting 3rd party video teleconferencing systems (VTCs). The Video Gateway and a Video Interop Server (VIS) use a Session Initiation Protocol (SIP) trunk to connect video calls between third party VTCs and internal endpoints. Video Trunks settings can be managed by using the CsVideoTrunkConfiguration cmdlets. @@ -280,4 +280,3 @@ The `Set-CsVideoTrunkConfiguration` cmdlet modifies existing instances of the Mi [New-CsVideoTrunkConfiguration](New-CsVideoTrunkConfiguration.md) [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md b/skype/skype-ps/skype/Set-CsVoiceConfiguration.md index 7410f4ce3f..55b566c49c 100644 --- a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVoiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoiceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoiceConfiguration schema: 2.0.0 @@ -214,4 +214,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Set-CsVoiceTestConfiguration](Set-CsVoiceTestConfiguration.md) [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md index 968239fc03..75e02f9f89 100644 --- a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoicenormalizationrule +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoiceNormalizationRule schema: 2.0.0 @@ -304,4 +304,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Set-CsDialPlan](Set-CsDialPlan.md) [Get-CsDialPlan](Get-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Set-CsVoicePolicy.md b/skype/skype-ps/skype/Set-CsVoicePolicy.md index 9a35761710..bd2491217f 100644 --- a/skype/skype-ps/skype/Set-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Set-CsVoicePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoicePolicy schema: 2.0.0 @@ -574,4 +574,3 @@ Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig. [Test-CsVoicePolicy](Test-CsVoicePolicy.md) [Get-CsPstnUsage](Get-CsPstnUsage.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceRoute.md b/skype/skype-ps/skype/Set-CsVoiceRoute.md index f1379ed7ec..7a66daa439 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Set-CsVoiceRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoiceRoute schema: 2.0.0 @@ -366,4 +366,3 @@ Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Writabl [Get-CsPstnUsage](Get-CsPstnUsage.md) [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md index 05cd14173b..1c2aeaffd5 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoiceRoutingPolicy schema: 2.0.0 @@ -241,4 +241,3 @@ Instead, the `Set-CsVoiceRoutingPolicy` cmdlet modifies existing instances of th [New-CsVoiceRoutingPolicy](New-CsVoiceRoutingPolicy.md) [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md index 0c3fe41f46..56905fbe1a 100644 --- a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoiceTestConfiguration schema: 2.0.0 @@ -302,4 +302,3 @@ This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Po [Get-CsDialPlan](Get-CsDialPlan.md) [Get-CsVoicePolicy](Get-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md index 4a8f40da33..b20a8c0c9d 100644 --- a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvoicemailreroutingconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsVoicemailReroutingConfiguration schema: 2.0.0 @@ -226,4 +226,3 @@ It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.E [Remove-CsVoicemailReroutingConfiguration](Remove-CsVoicemailReroutingConfiguration.md) [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md index 7647c21d99..8f943ec290 100644 --- a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsWatcherNodeConfiguration schema: 2.0.0 @@ -388,4 +388,3 @@ Instead, the `Set-CsWatcherNodeConfiguration` cmdlet modifies existing instances [Remove-CsWatcherNodeConfiguration](Remove-CsWatcherNodeConfiguration.md) [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Set-CsWebServer.md b/skype/skype-ps/skype/Set-CsWebServer.md index 37bf8e9c68..5bf3b8c7cc 100644 --- a/skype/skype-ps/skype/Set-CsWebServer.md +++ b/skype/skype-ps/skype/Set-CsWebServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cswebserver +online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsWebServer schema: 2.0.0 @@ -631,4 +631,3 @@ Instead, the `Set-CsWebServer` cmdlet modifies instances of the Microsoft.Rtc.Ma ## RELATED LINKS [Get-CsService](Get-CsService.md) - diff --git a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md b/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md index b2c896a4da..7a41b51175 100644 --- a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md +++ b/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cswebserviceconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsWebServiceConfiguration schema: 2.0.0 @@ -921,7 +921,7 @@ Accept wildcard characters: False ### -OverrideAuthTypeForExternalClients -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://docs.microsoft.com/powershell/module/skype/set-csauthconfig). +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). ```yaml Type: String @@ -937,7 +937,7 @@ Accept wildcard characters: False ### -OverrideAuthTypeForInternalClients -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://docs.microsoft.com/powershell/module/skype/set-csauthconfig). +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). ```yaml Type: String diff --git a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md index a33dbc6dee..cb19f7f293 100644 --- a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppallowedpartner +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta @@ -381,4 +381,3 @@ Instead, the `Set-CsXmppAllowedPartner` cmdlet modifies existing instances of th [New-CsXmppAllowedPartner](New-CsXmppAllowedPartner.md) [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) - diff --git a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md b/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md index 8e0c92b071..4a97a22ae7 100644 --- a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csxmppgatewayconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppgatewayconfiguration +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsXmppGatewayConfiguration schema: 2.0.0 manager: rogupta @@ -314,4 +314,3 @@ Instead, the `Set-CsXmppGatewayConfiguration` cmdlet modifies existing instances ## RELATED LINKS [Get-CsXmppGatewayConfiguration](Get-CsXmppGatewayConfiguration.md) - diff --git a/skype/skype-ps/skype/Show-CsClsLogging.md b/skype/skype-ps/skype/Show-CsClsLogging.md index ea88ab9b23..034eb323fd 100644 --- a/skype/skype-ps/skype/Show-CsClsLogging.md +++ b/skype/skype-ps/skype/Show-CsClsLogging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/show-csclslogging +online version: https://learn.microsoft.com/powershell/module/skype/show-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Show-CsClsLogging schema: 2.0.0 @@ -153,4 +153,3 @@ The `Show-CsClsLogging` cmdlet does not return objects. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Start-CsClsLogging.md b/skype/skype-ps/skype/Start-CsClsLogging.md index e1eb0f1629..52f1ac216a 100644 --- a/skype/skype-ps/skype/Start-CsClsLogging.md +++ b/skype/skype-ps/skype/Start-CsClsLogging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/start-csclslogging +online version: https://learn.microsoft.com/powershell/module/skype/start-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Start-CsClsLogging schema: 2.0.0 @@ -208,4 +208,3 @@ The `Start-CsClsLogging` cmdlet does not return objects. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Start-CsPool.md b/skype/skype-ps/skype/Start-CsPool.md index e5d44b4e87..61b0bbeaf5 100644 --- a/skype/skype-ps/skype/Start-CsPool.md +++ b/skype/skype-ps/skype/Start-CsPool.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/start-cspool +online version: https://learn.microsoft.com/powershell/module/skype/start-cspool applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Start-CsPool schema: 2.0.0 @@ -186,4 +186,3 @@ None [Backup-CsPool](Backup-CsPool.md) [Get-CsPool](Get-CsPool.md) - diff --git a/skype/skype-ps/skype/Start-CsWindowsService.md b/skype/skype-ps/skype/Start-CsWindowsService.md index 87534935ab..ab1c0c8008 100644 --- a/skype/skype-ps/skype/Start-CsWindowsService.md +++ b/skype/skype-ps/skype/Start-CsWindowsService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/start-cswindowsservice +online version: https://learn.microsoft.com/powershell/module/skype/start-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Start-CsWindowsService schema: 2.0.0 @@ -258,4 +258,3 @@ Instead, the `Start-CsWindowsService` cmdlet starts instances of the Microsoft.R [Get-CsWindowsService](Get-CsWindowsService.md) [Stop-CsWindowsService](Stop-CsWindowsService.md) - diff --git a/skype/skype-ps/skype/Stop-CsClsLogging.md b/skype/skype-ps/skype/Stop-CsClsLogging.md index b29b1f8b21..46d2784689 100644 --- a/skype/skype-ps/skype/Stop-CsClsLogging.md +++ b/skype/skype-ps/skype/Stop-CsClsLogging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/stop-csclslogging +online version: https://learn.microsoft.com/powershell/module/skype/stop-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Stop-CsClsLogging schema: 2.0.0 @@ -174,4 +174,3 @@ The `Stop-CsClsLogging` cmdlet does not return objects. [Sync-CsClsLogging](Sync-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Stop-CsWindowsService.md b/skype/skype-ps/skype/Stop-CsWindowsService.md index 3a03b4ae5d..fa3302b7ad 100644 --- a/skype/skype-ps/skype/Stop-CsWindowsService.md +++ b/skype/skype-ps/skype/Stop-CsWindowsService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/stop-cswindowsservice +online version: https://learn.microsoft.com/powershell/module/skype/stop-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Stop-CsWindowsService schema: 2.0.0 diff --git a/skype/skype-ps/skype/Sync-CsClsLogging.md b/skype/skype-ps/skype/Sync-CsClsLogging.md index a4a262d95c..f1e1fb7909 100644 --- a/skype/skype-ps/skype/Sync-CsClsLogging.md +++ b/skype/skype-ps/skype/Sync-CsClsLogging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/sync-csclslogging +online version: https://learn.microsoft.com/powershell/module/skype/sync-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Sync-CsClsLogging schema: 2.0.0 @@ -155,4 +155,3 @@ The `Sync-CsClsLogging` cmdlet does not return objects. [Stop-CsClsLogging](Stop-CsClsLogging.md) [Update-CsClsLogging](Update-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md b/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md deleted file mode 100644 index f3c4d24e3c..0000000000 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/sync-csonlineapplicationinstance -applicable: Microsoft Teams, Skype for Business Online -title: Sync-CsOnlineApplicationInstance -schema: 2.0.0 -author: xixian73 -ms.author: xixian -manager:naveenv -ms.reviewer: ---- - -# Sync-CsOnlineApplicationInstance - -## SYNOPSIS -Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Azure Active Directory into Agent Provisioning Service. - -## SYNTAX - -``` -Sync-CsOnlineApplicationInstance [-CallbackUri ] [-ObjectId ] [-ApplicationId ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Azure Active Directory into Agent Provisioning Service. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -```powershell -Sync-CsOnlineApplicationInstance -ObjectId 00000000-0000-0000-0000-000000000000 -``` - -This example sync application instance with object id "00000000-0000-0000-0000-000000000000" into Agent Provisioning Service. - -## PARAMETERS - -### -CallbackUri -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ObjectId -The application instance ID. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId -The application ID. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information`, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/skype/skype-ps/skype/Sync-CsUserData.md b/skype/skype-ps/skype/Sync-CsUserData.md index a35b68d334..24515c4190 100644 --- a/skype/skype-ps/skype/Sync-CsUserData.md +++ b/skype/skype-ps/skype/Sync-CsUserData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/sync-csuserdata +online version: https://learn.microsoft.com/powershell/module/skype/sync-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Sync-CsUserData schema: 2.0.0 @@ -136,4 +136,3 @@ None. [Import-CsUserData](Import-CsUserData.md) [Update-CsUserData](Update-CsUserData.md) - diff --git a/skype/skype-ps/skype/Test-CsASConference.md b/skype/skype-ps/skype/Test-CsASConference.md index ad96df9f2a..099b932352 100644 --- a/skype/skype-ps/skype/Test-CsASConference.md +++ b/skype/skype-ps/skype/Test-CsASConference.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csasconference +online version: https://learn.microsoft.com/powershell/module/skype/test-csasconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsASConference schema: 2.0.0 @@ -373,4 +373,3 @@ The `Test-CsASConference` cmdlet returns an instance of the Microsoft.Rtc.Synthe [Get-CsConferencingPolicy](Get-CsConferencingPolicy.md) [Test-CsDataConference](Test-CsDataConference.md) - diff --git a/skype/skype-ps/skype/Test-CsAVConference.md b/skype/skype-ps/skype/Test-CsAVConference.md index 24652064a2..10358b7db6 100644 --- a/skype/skype-ps/skype/Test-CsAVConference.md +++ b/skype/skype-ps/skype/Test-CsAVConference.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csavconference +online version: https://learn.microsoft.com/powershell/module/skype/test-csavconference applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsAVConference schema: 2.0.0 @@ -397,4 +397,3 @@ The `Test-CsAVConference` cmdlet returns an instance of the Microsoft.Rtc.Synthe [Get-CsAVEdgeConfiguration](Get-CsAVEdgeConfiguration.md) [Test-CsDialInConferencing](Test-CsDialInConferencing.md) - diff --git a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md b/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md index 057e0ee16f..4a02865927 100644 --- a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md +++ b/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csavedgeconnectivity +online version: https://learn.microsoft.com/powershell/module/skype/test-csavedgeconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsAVEdgeConnectivity schema: 2.0.0 @@ -326,4 +326,3 @@ The `Test-CsAVEdgeConnectivity` cmdlet returns instances of the Microsoft.Rtc.Sy ## RELATED LINKS [Get-CsAVEdgeConfiguration](Get-CsAVEdgeConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsAddressBookService.md b/skype/skype-ps/skype/Test-CsAddressBookService.md index bc8c537f3c..cd35b1f681 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookService.md +++ b/skype/skype-ps/skype/Test-CsAddressBookService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csaddressbookservice +online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsAddressBookService schema: 2.0.0 @@ -381,4 +381,3 @@ The `Test-CsAddressBookService` cmdlet returns an instance of the Microsoft.Rtc. [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) [Update-CsAddressBook](Update-CsAddressBook.md) - diff --git a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md b/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md index 97e17acf23..6347a249c5 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md +++ b/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csaddressbookwebquery +online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookwebquery applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsAddressBookWebQuery schema: 2.0.0 @@ -425,4 +425,3 @@ The `Test-CsAddressBookWebQuery` cmdlet returns an instance of the Microsoft.Rtc [Test-CsAddressBookService](Test-CsAddressBookService.md) [Update-CsAddressBook](Update-CsAddressBook.md) - diff --git a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md b/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md index 630ed37db2..5c7f75a011 100644 --- a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md +++ b/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csaudioconferencingprovider +online version: https://learn.microsoft.com/powershell/module/skype/test-csaudioconferencingprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsAudioConferencingProvider schema: 2.0.0 @@ -352,4 +352,3 @@ The `Test-CsAudioConferencingProvider` cmdlet returns an instance of the Microso ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md b/skype/skype-ps/skype/Test-CsCertificateConfiguration.md index 34f6cb9e57..a47d84c519 100644 --- a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md +++ b/skype/skype-ps/skype/Test-CsCertificateConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cscertificateconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/test-cscertificateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsCertificateConfiguration schema: 2.0.0 @@ -106,4 +106,3 @@ The `Test-CsCertificateConfiguration` cmdlet returns instances of the Microsoft. ## RELATED LINKS [Get-CsCertificate](Get-CsCertificate.md) - diff --git a/skype/skype-ps/skype/Test-CsClientAuth.md b/skype/skype-ps/skype/Test-CsClientAuth.md index e9752e286f..6bd285963b 100644 --- a/skype/skype-ps/skype/Test-CsClientAuth.md +++ b/skype/skype-ps/skype/Test-CsClientAuth.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csclientauth +online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauth applicable: Lync Server 2010 title: Test-CsClientAuth schema: 2.0.0 @@ -208,4 +208,3 @@ None. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsClientAuthentication.md b/skype/skype-ps/skype/Test-CsClientAuthentication.md index 9ab7439895..b8dd9c675a 100644 --- a/skype/skype-ps/skype/Test-CsClientAuthentication.md +++ b/skype/skype-ps/skype/Test-CsClientAuthentication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csclientauthentication +online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauthentication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsClientAuthentication schema: 2.0.0 @@ -247,4 +247,3 @@ The `Test-CsClientAuthentication` cmdlet returns an instance of the Microsoft.Rt [Get-CsWebServiceConfiguration](Get-CsWebServiceConfiguration.md) [Test-CsRegistration](Test-CsRegistration.md) - diff --git a/skype/skype-ps/skype/Test-CsComputer.md b/skype/skype-ps/skype/Test-CsComputer.md index 228ead7f72..24f055387a 100644 --- a/skype/skype-ps/skype/Test-CsComputer.md +++ b/skype/skype-ps/skype/Test-CsComputer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cscomputer +online version: https://learn.microsoft.com/powershell/module/skype/test-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsComputer schema: 2.0.0 @@ -113,4 +113,3 @@ The `Test-CsComputer` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT [Enable-CsComputer](Enable-CsComputer.md) [Get-CsComputer](Get-CsComputer.md) - diff --git a/skype/skype-ps/skype/Test-CsDataConference.md b/skype/skype-ps/skype/Test-CsDataConference.md index 743e8477ca..261a1b7fce 100644 --- a/skype/skype-ps/skype/Test-CsDataConference.md +++ b/skype/skype-ps/skype/Test-CsDataConference.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csdataconference +online version: https://learn.microsoft.com/powershell/module/skype/test-csdataconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsDataConference schema: 2.0.0 @@ -67,7 +67,7 @@ $credential2 = Get-Credential "litwareinc\kenmyer" Test-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" -SenderSipAddress "sip:pilar@litwareinc.com" -SenderCredential $credential1 -ReceiverSipAddress "sip:kenmyer@litwareinc.com" -ReceiverCredential $credential2 ``` -The commands shown in Example 2 test the ability of a pair of users (litwareinc\pilar and litwareinc\kenmyer) to log on to Skype for Business Server and then conduct an data conference. +The commands shown in Example 2 test the ability of a pair of users (litwareinc\pilar and litwareinc\kenmyer) to log on to Skype for Business Server and then conduct a data conference. To do this, the first command in the example uses the `Get-Credential` cmdlet to create a Windows PowerShell command-line interface credential object containing the name and password of the user Pilar Ackerman. (Because the logon name, litwareinc\pilar, has been included as a parameter, the Windows PowerShell Credential Request dialog box only requires the administrator to enter the password for the Pilar Ackerman account.) The resulting credential object is then stored in a variable named $cred1. The second command does the same thing, this time returning a credential object for the Ken Myer account. @@ -395,4 +395,3 @@ The `Test-CsDataConference` cmdlet returns instances of the Microsoft.Rtc.Synthe ## RELATED LINKS [Test-CsASConference](Test-CsASConference.md) - diff --git a/skype/skype-ps/skype/Test-CsDatabase.md b/skype/skype-ps/skype/Test-CsDatabase.md index 6e143b1ce6..8d7c71703f 100644 --- a/skype/skype-ps/skype/Test-CsDatabase.md +++ b/skype/skype-ps/skype/Test-CsDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csdatabase +online version: https://learn.microsoft.com/powershell/module/skype/test-csdatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsDatabase schema: 2.0.0 @@ -309,4 +309,3 @@ The `Test-CsDatabase` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT [Get-CsService](Get-CsService.md) [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) - diff --git a/skype/skype-ps/skype/Test-CsDialInConferencing.md b/skype/skype-ps/skype/Test-CsDialInConferencing.md index ff1e1a8dd0..b081788241 100644 --- a/skype/skype-ps/skype/Test-CsDialInConferencing.md +++ b/skype/skype-ps/skype/Test-CsDialInConferencing.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csdialinconferencing +online version: https://learn.microsoft.com/powershell/module/skype/test-csdialinconferencing applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsDialInConferencing schema: 2.0.0 @@ -357,4 +357,3 @@ The `Test-CsDialInConferencing` cmdlet returns an instance of the Microsoft.Rtc. ## RELATED LINKS [Test-CsAVConference](Test-CsAVConference.md) - diff --git a/skype/skype-ps/skype/Test-CsDialPlan.md b/skype/skype-ps/skype/Test-CsDialPlan.md index 0f834eec29..77e180d416 100644 --- a/skype/skype-ps/skype/Test-CsDialPlan.md +++ b/skype/skype-ps/skype/Test-CsDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csdialplan +online version: https://learn.microsoft.com/powershell/module/skype/test-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsDialPlan schema: 2.0.0 @@ -145,4 +145,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.LocationProfileTestResu [Get-CsDialPlan](Get-CsDialPlan.md) [Grant-CsDialPlan](Grant-CsDialPlan.md) - diff --git a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md b/skype/skype-ps/skype/Test-CsExStorageConnectivity.md index acff8e4575..c2e02985e3 100644 --- a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md +++ b/skype/skype-ps/skype/Test-CsExStorageConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csexstorageconnectivity +online version: https://learn.microsoft.com/powershell/module/skype/test-csexstorageconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsExStorageConnectivity schema: 2.0.0 @@ -209,4 +209,3 @@ The `Test-CsExStorageConnectivity` cmdlet returns instances of the Microsoft.Rtc ## RELATED LINKS [Test-CsExStorageNotification](Test-CsExStorageNotification.md) - diff --git a/skype/skype-ps/skype/Test-CsExStorageNotification.md b/skype/skype-ps/skype/Test-CsExStorageNotification.md index 4f95aa6033..0a1a1928e8 100644 --- a/skype/skype-ps/skype/Test-CsExStorageNotification.md +++ b/skype/skype-ps/skype/Test-CsExStorageNotification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csexstoragenotification +online version: https://learn.microsoft.com/powershell/module/skype/test-csexstoragenotification applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsExStorageNotification schema: 2.0.0 @@ -151,4 +151,3 @@ The `Test-CsExStorageNotification` cmdlet returns instances of the Microsoft.Rtc ## RELATED LINKS [Test-CsExStorageConnectivity](Test-CsExStorageConnectivity.md) - diff --git a/skype/skype-ps/skype/Test-CsExUMConnectivity.md b/skype/skype-ps/skype/Test-CsExUMConnectivity.md index faf807cc92..89de2a0acc 100644 --- a/skype/skype-ps/skype/Test-CsExUMConnectivity.md +++ b/skype/skype-ps/skype/Test-CsExUMConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csexumconnectivity +online version: https://learn.microsoft.com/powershell/module/skype/test-csexumconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsExUMConnectivity schema: 2.0.0 @@ -302,4 +302,3 @@ The `Test-CsExUMConnectivity` cmdlet returns an instance of the Microsoft.Rtc.Sy ## RELATED LINKS [Test-CsExUMVoiceMail](Test-CsExUMVoiceMail.md) - diff --git a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md b/skype/skype-ps/skype/Test-CsExUMVoiceMail.md index 6aa7256cc4..54fb97e64e 100644 --- a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md +++ b/skype/skype-ps/skype/Test-CsExUMVoiceMail.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csexumvoicemail +online version: https://learn.microsoft.com/powershell/module/skype/test-csexumvoicemail applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsExUMVoiceMail schema: 2.0.0 @@ -355,4 +355,3 @@ The `Test-CsExUMVoiceMail` cmdlet returns an instance of the Microsoft.Rtc.Synth ## RELATED LINKS [Test-CsExUMConnectivity](Test-CsExUMConnectivity.md) - diff --git a/skype/skype-ps/skype/Test-CsFederatedPartner.md b/skype/skype-ps/skype/Test-CsFederatedPartner.md index 970daaae78..91379de7a9 100644 --- a/skype/skype-ps/skype/Test-CsFederatedPartner.md +++ b/skype/skype-ps/skype/Test-CsFederatedPartner.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csfederatedpartner +online version: https://learn.microsoft.com/powershell/module/skype/test-csfederatedpartner applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsFederatedPartner schema: 2.0.0 @@ -234,4 +234,3 @@ None. ## RELATED LINKS [Get-CsAllowedDomain](Get-CsAllowedDomain.md) - diff --git a/skype/skype-ps/skype/Test-CsGroupExpansion.md b/skype/skype-ps/skype/Test-CsGroupExpansion.md index fc2db61665..857d5182b8 100644 --- a/skype/skype-ps/skype/Test-CsGroupExpansion.md +++ b/skype/skype-ps/skype/Test-CsGroupExpansion.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csgroupexpansion +online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupexpansion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsGroupExpansion schema: 2.0.0 @@ -396,4 +396,3 @@ The `Test-CsGroupExpansion` cmdlet returns an instance of the Microsoft.Rtc.Synt [Test-CsAddressBookService](Test-CsAddressBookService.md) [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) - diff --git a/skype/skype-ps/skype/Test-CsGroupIM.md b/skype/skype-ps/skype/Test-CsGroupIM.md index 7474e28833..02b1dae31c 100644 --- a/skype/skype-ps/skype/Test-CsGroupIM.md +++ b/skype/skype-ps/skype/Test-CsGroupIM.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csgroupim +online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsGroupIM schema: 2.0.0 @@ -410,4 +410,3 @@ The `Test-CsGroupIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTr ## RELATED LINKS [Test-CsIM](Test-CsIM.md) - diff --git a/skype/skype-ps/skype/Test-CsIM.md b/skype/skype-ps/skype/Test-CsIM.md index f587a41127..76029053a9 100644 --- a/skype/skype-ps/skype/Test-CsIM.md +++ b/skype/skype-ps/skype/Test-CsIM.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csim +online version: https://learn.microsoft.com/powershell/module/skype/test-csim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsIM schema: 2.0.0 @@ -495,4 +495,3 @@ The `Test-CsIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransac ## RELATED LINKS [Test-CsGroupIM](Test-CsGroupIM.md) - diff --git a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md b/skype/skype-ps/skype/Test-CsInterTrunkRouting.md index 6be112cae7..c0afe78bea 100644 --- a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md +++ b/skype/skype-ps/skype/Test-CsInterTrunkRouting.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csintertrunkrouting +online version: https://learn.microsoft.com/powershell/module/skype/test-csintertrunkrouting applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsInterTrunkRouting schema: 2.0.0 @@ -143,4 +143,3 @@ None. [Get-CsTrunk](Get-CsTrunk.md) [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md b/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md index 3c4c804f96..f5ecfa9315 100644 --- a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cskerberosaccountassignment +online version: https://learn.microsoft.com/powershell/module/skype/test-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsKerberosAccountAssignment schema: 2.0.0 @@ -120,4 +120,3 @@ The `Test-CsKerberosAccountAssignment` cmdlet does not return any objects or val [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) - diff --git a/skype/skype-ps/skype/Test-CsLisCivicAddress.md b/skype/skype-ps/skype/Test-CsLisCivicAddress.md index cc3dc95f08..2ff376a8bc 100644 --- a/skype/skype-ps/skype/Test-CsLisCivicAddress.md +++ b/skype/skype-ps/skype/Test-CsLisCivicAddress.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csliscivicaddress +online version: https://learn.microsoft.com/powershell/module/skype/test-csliscivicaddress applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsLisCivicAddress schema: 2.0.0 @@ -311,4 +311,3 @@ This cmdlet does not return a value. ## RELATED LINKS [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) - diff --git a/skype/skype-ps/skype/Test-CsLisConfiguration.md b/skype/skype-ps/skype/Test-CsLisConfiguration.md index 3dd8ec3b69..40c2654be8 100644 --- a/skype/skype-ps/skype/Test-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Test-CsLisConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/test-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsLisConfiguration schema: 2.0.0 @@ -100,7 +100,7 @@ Test-CsLisConfiguration -TargetUri https://atl-cs-001.litwareinc.com/locationinf The first line of this example calls the `Get-Credential` cmdlet, which prompts the user for a user ID and password. This information is stored in an encrypted fashion in the variable $cred. -Line 2 tests the LIS configuration by making a call to the web service URI (https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc) based on the SIP address of the remote user (sip:kmyer@litwareinc.com), and using the credentials we obtained in line 1 by passing them to the WebCredential parameter. +Line 2 tests the LIS configuration by making a call to the web service URI (`https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc`) based on the SIP address of the remote user (sip:kmyer@litwareinc.com), and using the credentials we obtained in line 1 by passing them to the WebCredential parameter. The test will be successful if a connection can be made with the given user credentials to the LIS web service at that URI. If a location can be found that maps to the subnet IP address 192.168.0.0, the MAC address 0A-23-00-00-00-AA or the Port ID 4500 and ChassisId 0A-23-00-00-00-AA, that location address will be returned. @@ -504,4 +504,3 @@ The `Test-CsLisConfiguration` cmdlet returns an instance of the Microsoft.Rtc.Sy [Import-CsLisConfiguration](Import-CsLisConfiguration.md) [Export-CsLisConfiguration](Export-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsLocationPolicy.md b/skype/skype-ps/skype/Test-CsLocationPolicy.md index c09d1d445e..a4881b7d5b 100644 --- a/skype/skype-ps/skype/Test-CsLocationPolicy.md +++ b/skype/skype-ps/skype/Test-CsLocationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cslocationpolicy +online version: https://learn.microsoft.com/powershell/module/skype/test-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsLocationPolicy schema: 2.0.0 @@ -347,4 +347,3 @@ The `Test-CsLocationPolicy` cmdlet returns an instance of the Microsoft.Rtc.Synt [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) [Set-CsNetworkSite](Set-CsNetworkSite.md) - diff --git a/skype/skype-ps/skype/Test-CsManagementServer.md b/skype/skype-ps/skype/Test-CsManagementServer.md index 248d4db513..3f9787e03b 100644 --- a/skype/skype-ps/skype/Test-CsManagementServer.md +++ b/skype/skype-ps/skype/Test-CsManagementServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csmanagementserver +online version: https://learn.microsoft.com/powershell/module/skype/test-csmanagementserver applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsManagementServer schema: 2.0.0 @@ -81,4 +81,3 @@ The `Test-CsManagementServer` cmdlet returns an instance of the Microsoft.Rtc.Sy ## RELATED LINKS [Set-CsManagementServer](Set-CsManagementServer.md) - diff --git a/skype/skype-ps/skype/Test-CsMcxConference.md b/skype/skype-ps/skype/Test-CsMcxConference.md index c79b9c202e..ead7987bb7 100644 --- a/skype/skype-ps/skype/Test-CsMcxConference.md +++ b/skype/skype-ps/skype/Test-CsMcxConference.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csmcxconference -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxconference +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxConference schema: 2.0.0 manager: rogupta @@ -325,4 +325,3 @@ The `Test-CsMcxConference` cmdlet returns an instance of the Microsoft.Rtc.Synth ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsMcxP2PIM.md b/skype/skype-ps/skype/Test-CsMcxP2PIM.md index fefa5099f4..b56a148b8b 100644 --- a/skype/skype-ps/skype/Test-CsMcxP2PIM.md +++ b/skype/skype-ps/skype/Test-CsMcxP2PIM.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csmcxp2pim -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxP2PIM schema: 2.0.0 manager: rogupta @@ -278,4 +278,3 @@ The `Test-CsMcxP2PIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsMcxPushNotification.md b/skype/skype-ps/skype/Test-CsMcxPushNotification.md index 5bdab7b30f..cc044294c2 100644 --- a/skype/skype-ps/skype/Test-CsMcxPushNotification.md +++ b/skype/skype-ps/skype/Test-CsMcxPushNotification.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csmcxpushnotification -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxPushNotification schema: 2.0.0 manager: rogupta @@ -170,4 +170,3 @@ The `Test-CsMcxPushNotification` cmdlet returns an instance of the Microsoft.Rtc ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsOUPermission.md b/skype/skype-ps/skype/Test-CsOUPermission.md index e75aac65b5..1dfd1ab566 100644 --- a/skype/skype-ps/skype/Test-CsOUPermission.md +++ b/skype/skype-ps/skype/Test-CsOUPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csoupermission +online version: https://learn.microsoft.com/powershell/module/skype/test-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsOUPermission schema: 2.0.0 @@ -213,4 +213,3 @@ The `Test-CsOUPermission` cmdlet returns an instance of the Microsoft.Rtc.Synthe [Grant-CsOUPermission](Grant-CsOUPermission.md) [Revoke-CsOUPermission](Revoke-CsOUPermission.md) - diff --git a/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md b/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md deleted file mode 100644 index 74e7b80c01..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csonlinecarrierportabilityin -applicable: Skype for Business Online -title: Test-CsOnlineCarrierPortabilityIn -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Test-CsOnlineCarrierPortabilityIn - -## SYNOPSIS -This cmdlet is reserved for Microsoft internal use only. - - -## SYNTAX - -``` -Test-CsOnlineCarrierPortabilityIn -TelephoneNumbers [-DomainController ] [-Force] [-WhatIf] - [-Confirm] [] -``` - - -## DESCRIPTION - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` - -``` - - -## PARAMETERS - -### -TelephoneNumbers -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md b/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md deleted file mode 100644 index c7bd82b499..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csonlineliscivicaddress -applicable: Skype for Business Online -title: Test-CsOnlineLisCivicAddress -schema: 2.0.0 -manager: bulenteg -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# Test-CsOnlineLisCivicAddress - - -## SYNOPSIS -Use the \`Test-CsOnlineLisCivicAddress\` cmdlet to verify that a civic address exists in the master street address guide (MSAG), and is suitable for emergency dispatch. - -> [!NOTE] -> This cmdlet has been removed. The validation checks are incorporated into New-CsOnlineLisCivicAddress. - -## SYNTAX - -### TestWithExistingAddr (Default) -``` -Test-CsOnlineLisCivicAddress -CivicAddressId [-Tenant ] [-DomainController ] [-Force] - [] -``` - -### TestWithNewAddr -``` -Test-CsOnlineLisCivicAddress -CompanyName [-CompanyTaxId ] [-HouseNumber ] - [-HouseNumberSuffix ] [-StreetName ] [-StreetSuffix ] [-PostDirectional ] - [-PreDirectional ] [-City ] [-StateOrProvince ] -CountryOrRegion - [-PostalCode ] [-Description ] [-Tenant ] [-DomainController ] [-Force] - [] -``` - - -## DESCRIPTION -The \`Test-CsOnlineLisCivicAddress\` cmdlet operates in two modes. - -Validate and report: When called along with a list of address parameters, the cmdlet will test the address and report the result. -Neither the address, nor the validation status is saved in the Location Information Service (LIS.) Use this mode to verify the address before creating it using the \`New-CsOnlineLisCivicAddress\` cmdlet. - -Validate and save: When called with only the CivicAddressId parameter specified, the cmdlet will test the address and, if validated, save the validation status in the Location Information Service (LIS.) - -The \`Test-CsOnlineLisCivicAddress\` produces three results: - -Accepted as is: The address entered (validate and report mode), or specified (validate and save mode) is valid. - -Accepted with changes: The address entered or specified would be valid with changes. -The changes required are specified in the output. - -Rejected: The address entered or specified cannot be found, and no suggested changes can be defined. -The output will contain the reason the validation failed. - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -Test-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -``` - -This example tests emergency dispatch suitability for the civic address with the specified identification. - - -### -------------------------- Example 2 -------------------------- -``` -Test-CsOnlineLisCivicAddress -HouseNumber 3910 -StreetName Smith -StreetSuffix Street -PostDirectional NE -City Redmond -StateorProvince Washington -CountryOrRegion US -PostalCode 98052 -Description "Puget Sound" -CompanyName Contoso -``` - -This examples tests the emergency dispatch suitability for the civic address specified by address definition parameters. - - -## PARAMETERS - -### -CivicAddressId -Specifies the identification number of the civic address to test. -If specified, no other address definition parameters are allowed. -Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. - -```yaml -Type: Guid -Parameter Sets: TestWithExistingAddr -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyName -Specifies the name of your organization. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -Specifies the country or region of the civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the city of the civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompanyTaxId -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies an administrator defined description of the civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business 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: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumber -Specifies the numeric portion of the civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HouseNumberSuffix -Specifies the numeric suffix of the civic address. -For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the postal code of the civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -Specifies the state or province of the new civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetName -Specifies the street name of the civic address. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetSuffix -Specifies a modifier of the street name of the civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. - -```yaml -Type: String -Parameter Sets: TestWithNewAddr -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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 - -### The address accepts pipelined input from the \`Get-CsOnlineLisCivicAddress\` cmdlet. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md b/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md deleted file mode 100644 index 466f082f6d..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csonlineportabilityin -applicable: Skype for Business Online -title: Test-CsOnlinePortabilityIn -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Test-CsOnlinePortabilityIn - -## SYNOPSIS -Tests the ability to use ported phone numbers from your current service provider to Skype for Business. - -## SYNTAX - -``` -Test-CsOnlinePortabilityIn [-TelephoneNumbers ] [-TelephoneNumberRanges ] - [-DomainController ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Tests the ability to use ported phone numbers from your current service provider to Skype for Business. - - -## EXAMPLES - -### -------------------------- Example 1 -------------------------- -``` -PS C:\> -``` - -Insert descriptive text for example 1. - - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is reserved for Microsoft internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumberRanges -Defines a telephone number range to test. For example, let's say you want to test all of your 25 phone numbers (+1 425-555-1235 through 1259). You should enter: "+14255551234-+14255551259". - -```yaml -Type: String[][] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumbers -Defines a list of telephone numbers to test. For example, let's say you want to test +1 425-555-1235, +1 425-555-1245 and +1 425-555-1259. You should enter: "+14255551235,+14255551245,+14255551259". - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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: Skype for Business 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/skype/skype-ps/skype/Test-CsP2PAV.md b/skype/skype-ps/skype/Test-CsP2PAV.md index c1499381e0..8c3e9d9900 100644 --- a/skype/skype-ps/skype/Test-CsP2PAV.md +++ b/skype/skype-ps/skype/Test-CsP2PAV.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csp2pav +online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pav applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsP2PAV schema: 2.0.0 @@ -388,4 +388,3 @@ The `Test-CsP2PAV` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTran ## RELATED LINKS [Test-CsAVConference](Test-CsAVConference.md) - diff --git a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md b/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md index 27eeb9d043..73035ead45 100644 --- a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md +++ b/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csp2pvideointeropserversiptrunkav +online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pvideointeropserversiptrunkav applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsP2PVideoInteropServerSipTrunkAV schema: 2.0.0 @@ -298,4 +298,3 @@ None [New-CsVideoInteropServerSyntheticTransactionConfiguration](New-CsVideoInteropServerSyntheticTransactionConfiguration.md) [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md b/skype/skype-ps/skype/Test-CsPersistentChatMessage.md index 8d8ecba333..d670ad8f25 100644 --- a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md +++ b/skype/skype-ps/skype/Test-CsPersistentChatMessage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cspersistentchatmessage -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-cspersistentchatmessage +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPersistentChatMessage schema: 2.0.0 manager: rogupta @@ -423,4 +423,3 @@ The `Test-CsPersistentChatMessage` cmdlet returns instances of the Microsoft.Rtc [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) - diff --git a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md b/skype/skype-ps/skype/Test-CsPhoneBootstrap.md index 7fa01b9e0d..d6cb06ded2 100644 --- a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md +++ b/skype/skype-ps/skype/Test-CsPhoneBootstrap.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csphonebootstrap +online version: https://learn.microsoft.com/powershell/module/skype/test-csphonebootstrap applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPhoneBootstrap schema: 2.0.0 @@ -283,4 +283,3 @@ The `Test-CsPhoneBootstrap` cmdlet returns an instance of the Microsoft.Rtc.Synt ## RELATED LINKS [Test-CsRegistration](Test-CsRegistration.md) - diff --git a/skype/skype-ps/skype/Test-CsPresence.md b/skype/skype-ps/skype/Test-CsPresence.md index f7753fd098..8a2d1f60ca 100644 --- a/skype/skype-ps/skype/Test-CsPresence.md +++ b/skype/skype-ps/skype/Test-CsPresence.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cspresence +online version: https://learn.microsoft.com/powershell/module/skype/test-cspresence applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPresence schema: 2.0.0 @@ -406,4 +406,3 @@ The `Test-CsPresence` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT ## RELATED LINKS [Test-CsRegistration](Test-CsRegistration.md) - diff --git a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md b/skype/skype-ps/skype/Test-CsPstnOutboundCall.md index 7f4f305a30..dad3350baa 100644 --- a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md +++ b/skype/skype-ps/skype/Test-CsPstnOutboundCall.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cspstnoutboundcall +online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnoutboundcall applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPstnOutboundCall schema: 2.0.0 @@ -358,4 +358,3 @@ The `Test-CsPstnOutboundCall` cmdlet returns an instance of the Microsoft.Rtc.Sy ## RELATED LINKS [Test-CsPstnPeerToPeerCall](Test-CsPstnPeerToPeerCall.md) - diff --git a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md b/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md index 21e93d6e70..58c8bf1766 100644 --- a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md +++ b/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cspstnpeertopeercall +online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnpeertopeercall applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPstnPeerToPeerCall schema: 2.0.0 @@ -401,4 +401,3 @@ The `Test-CsPstnPeerToPeerCall` cmdlet returns an instance of the Microsoft.Rtc. ## RELATED LINKS [Test-CsPstnOutboundCall](Test-CsPstnOutboundCall.md) - diff --git a/skype/skype-ps/skype/Test-CsRegistration.md b/skype/skype-ps/skype/Test-CsRegistration.md index 2e6ef3d99f..6310aa0ec1 100644 --- a/skype/skype-ps/skype/Test-CsRegistration.md +++ b/skype/skype-ps/skype/Test-CsRegistration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csregistration +online version: https://learn.microsoft.com/powershell/module/skype/test-csregistration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsRegistration schema: 2.0.0 @@ -329,4 +329,3 @@ The `Test-CsRegistration` cmdlet returns an instance of the Microsoft.Rtc.Synthe ## RELATED LINKS [Test-CsClientAuth](Test-CsClientAuth.md) - diff --git a/skype/skype-ps/skype/Test-CsReplica.md b/skype/skype-ps/skype/Test-CsReplica.md index d5ec18f110..fa960e4ed6 100644 --- a/skype/skype-ps/skype/Test-CsReplica.md +++ b/skype/skype-ps/skype/Test-CsReplica.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csreplica +online version: https://learn.microsoft.com/powershell/module/skype/test-csreplica applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsReplica schema: 2.0.0 @@ -132,4 +132,3 @@ The `Test-CsReplica` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTr ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsSetupPermission.md b/skype/skype-ps/skype/Test-CsSetupPermission.md index 2f2c7072f4..d3a68325b5 100644 --- a/skype/skype-ps/skype/Test-CsSetupPermission.md +++ b/skype/skype-ps/skype/Test-CsSetupPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cssetuppermission +online version: https://learn.microsoft.com/powershell/module/skype/test-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsSetupPermission schema: 2.0.0 @@ -172,4 +172,3 @@ The `Test-CsSetupPermission` cmdlet returns an instance of the Microsoft.Rtc.Syn [Grant-CsSetupPermission](Grant-CsSetupPermission.md) [Revoke-CsSetupPermission](Revoke-CsSetupPermission.md) - diff --git a/skype/skype-ps/skype/Test-CsTopology.md b/skype/skype-ps/skype/Test-CsTopology.md index 1bc1b46019..09df3bc984 100644 --- a/skype/skype-ps/skype/Test-CsTopology.md +++ b/skype/skype-ps/skype/Test-CsTopology.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cstopology +online version: https://learn.microsoft.com/powershell/module/skype/test-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsTopology schema: 2.0.0 @@ -178,4 +178,3 @@ The `Test-CsTopology` cmdlet returns an instance of the Microsoft.Rtc.SyntheticT [Get-CsTopology](Get-CsTopology.md) [Publish-CsTopology](Publish-CsTopology.md) - diff --git a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md b/skype/skype-ps/skype/Test-CsTrunkConfiguration.md index eb6bc07484..7cbb042b1c 100644 --- a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md +++ b/skype/skype-ps/skype/Test-CsTrunkConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cstrunkconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/test-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsTrunkConfiguration schema: 2.0.0 @@ -125,4 +125,3 @@ Returns a value of type Microsoft.Rtc.Management.Voice.TrunkConfigurationTestRes [Set-CsTrunkConfiguration](Set-CsTrunkConfiguration.md) [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsUcwaConference.md b/skype/skype-ps/skype/Test-CsUcwaConference.md index 0ef2f8a2bf..c94960225f 100644 --- a/skype/skype-ps/skype/Test-CsUcwaConference.md +++ b/skype/skype-ps/skype/Test-CsUcwaConference.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csucwaconference +online version: https://learn.microsoft.com/powershell/module/skype/test-csucwaconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsUcwaConference schema: 2.0.0 @@ -364,4 +364,3 @@ The `Test-CsUcwaConference` cmdlet returns instances of the Microsoft.Rtc.Synthe [Test-CsDataConference](Test-CsDataConference.md) [Test-CsAVConference](Test-CsAVConference.md) - diff --git a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md b/skype/skype-ps/skype/Test-CsUnifiedContactStore.md index 594dadcca0..e4e5ffea71 100644 --- a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md +++ b/skype/skype-ps/skype/Test-CsUnifiedContactStore.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csunifiedcontactstore +online version: https://learn.microsoft.com/powershell/module/skype/test-csunifiedcontactstore applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsUnifiedContactStore schema: 2.0.0 @@ -317,4 +317,3 @@ The `Test-CsUnifiedContactStore` cmdlet returns instances of the Microsoft.Rtc.S [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md index 5cac6b55b4..7506be3ac9 100644 --- a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csvoicenormalizationrule -applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicenormalizationrule +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsVoiceNormalizationRule schema: 2.0.0 manager: bulenteg author: jenstrier -ms.author: jenstr +ms.author: serdars --- # Test-CsVoiceNormalizationRule @@ -160,4 +160,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestRe [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) -[Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) diff --git a/skype/skype-ps/skype/Test-CsVoicePolicy.md b/skype/skype-ps/skype/Test-CsVoicePolicy.md index b6550b3b5a..9e26043f76 100644 --- a/skype/skype-ps/skype/Test-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Test-CsVoicePolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csvoicepolicy +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsVoicePolicy schema: 2.0.0 @@ -165,4 +165,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.VoicePolicyTestResult. [Get-CsVoicePolicy](Get-CsVoicePolicy.md) [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceRoute.md b/skype/skype-ps/skype/Test-CsVoiceRoute.md index 318642e570..4291233efd 100644 --- a/skype/skype-ps/skype/Test-CsVoiceRoute.md +++ b/skype/skype-ps/skype/Test-CsVoiceRoute.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csvoiceroute +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsVoiceRoute schema: 2.0.0 @@ -169,4 +169,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.VoiceRouteTestResult. [Set-CsVoiceRoute](Set-CsVoiceRoute.md) [Get-CsVoiceRoute](Get-CsVoiceRoute.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md b/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md index f98e41cb87..ff6c869062 100644 --- a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csvoicetestconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsVoiceTestConfiguration schema: 2.0.0 @@ -265,4 +265,3 @@ This cmdlet returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceTes [Get-CsVoicePolicy](Get-CsVoicePolicy.md) [Get-CsRoutingConfiguration](Get-CsRoutingConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsVoiceUser.md b/skype/skype-ps/skype/Test-CsVoiceUser.md index abf94a7ec7..d31c01af75 100644 --- a/skype/skype-ps/skype/Test-CsVoiceUser.md +++ b/skype/skype-ps/skype/Test-CsVoiceUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csvoiceuser +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsVoiceUser schema: 2.0.0 @@ -137,4 +137,3 @@ Returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceUserTestResult. ## RELATED LINKS [Get-CsUser](Get-CsUser.md) - diff --git a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md b/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md index 52b3ddc0cd..ab6e773b6e 100644 --- a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cswatchernodeconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/test-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsWatcherNodeConfiguration schema: 2.0.0 @@ -111,4 +111,3 @@ The `Test-CsWatcherNodeConfiguration` cmdlet returns an instance of the Microsof [Remove-CsWatcherNodeConfiguration](Remove-CsWatcherNodeConfiguration.md) [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) - diff --git a/skype/skype-ps/skype/Test-CsWebApp.md b/skype/skype-ps/skype/Test-CsWebApp.md index 35fff83307..fc6945a42c 100644 --- a/skype/skype-ps/skype/Test-CsWebApp.md +++ b/skype/skype-ps/skype/Test-CsWebApp.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cswebapp +online version: https://learn.microsoft.com/powershell/module/skype/test-cswebapp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsWebApp schema: 2.0.0 @@ -415,4 +415,3 @@ The Test-CsWebApp cmdlet returns an instance of the Microsoft.Rtc.SyntheticTrans ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md b/skype/skype-ps/skype/Test-CsWebAppAnonymous.md index 915b872dfc..56fef6875f 100644 --- a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md +++ b/skype/skype-ps/skype/Test-CsWebAppAnonymous.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cswebappanonymous +online version: https://learn.microsoft.com/powershell/module/skype/test-cswebappanonymous applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsWebAppAnonymous schema: 2.0.0 @@ -365,4 +365,3 @@ The `Test-CsWebAppAnonymous` cmdlet returns an instance of the Microsoft.Rtc.Syn ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsWebScheduler.md b/skype/skype-ps/skype/Test-CsWebScheduler.md index c555e8cdae..8339aaae79 100644 --- a/skype/skype-ps/skype/Test-CsWebScheduler.md +++ b/skype/skype-ps/skype/Test-CsWebScheduler.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cswebscheduler +online version: https://learn.microsoft.com/powershell/module/skype/test-cswebscheduler applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsWebScheduler schema: 2.0.0 @@ -358,4 +358,3 @@ The `Test-CsWebScheduler` cmdlet returns instances of the Microsoft.Rtc.Syntheti ## RELATED LINKS [Set-CsWebServer](Set-CsWebServer.md) - diff --git a/skype/skype-ps/skype/Test-CsXmppIM.md b/skype/skype-ps/skype/Test-CsXmppIM.md index 3ea326f491..2f3d174cf0 100644 --- a/skype/skype-ps/skype/Test-CsXmppIM.md +++ b/skype/skype-ps/skype/Test-CsXmppIM.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csxmppim -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/test-csxmppim +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsXmppIM schema: 2.0.0 manager: rogupta @@ -303,4 +303,3 @@ The `Test-CsXmppIM` cmdlet returns instances of the Microsoft.Rtc.SyntheticTrans ## RELATED LINKS [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) - diff --git a/skype/skype-ps/skype/Uninstall-CsDatabase.md b/skype/skype-ps/skype/Uninstall-CsDatabase.md index 8c77cb286c..5963d866fb 100644 --- a/skype/skype-ps/skype/Uninstall-CsDatabase.md +++ b/skype/skype-ps/skype/Uninstall-CsDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/uninstall-csdatabase +online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Uninstall-CsDatabase schema: 2.0.0 @@ -260,4 +260,3 @@ The `Uninstall-CsDatabase` cmdlet does not return any values or objects. ## RELATED LINKS [Install-CsDatabase](Install-CsDatabase.md) - diff --git a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md b/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md index 78af735007..882ce126eb 100644 --- a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md +++ b/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/uninstall-csmirrordatabase -applicable: Lync Server 2013, Skype for Business Server 2015 +online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csmirrordatabase +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Uninstall-CsMirrorDatabase schema: 2.0.0 manager: rogupta @@ -222,4 +222,3 @@ None. [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) - diff --git a/skype/skype-ps/skype/Unlock-CsClientPin.md b/skype/skype-ps/skype/Unlock-CsClientPin.md index c2107c758d..9e0e115c1e 100644 --- a/skype/skype-ps/skype/Unlock-CsClientPin.md +++ b/skype/skype-ps/skype/Unlock-CsClientPin.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/unlock-csclientpin +online version: https://learn.microsoft.com/powershell/module/skype/unlock-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Unlock-CsClientPin schema: 2.0.0 @@ -157,4 +157,3 @@ Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Manage [Lock-CsClientPin](Lock-CsClientPin.md) [Set-CsClientPin](Set-CsClientPin.md) - diff --git a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md b/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md index ff347dba21..6b754867cf 100644 --- a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/unpublish-cslisconfiguration +online version: https://learn.microsoft.com/powershell/module/skype/unpublish-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Unpublish-CsLisConfiguration schema: 2.0.0 @@ -117,4 +117,3 @@ This cmdlet does not return a value. [Export-CsLisConfiguration](Export-CsLisConfiguration.md) [Test-CsLisConfiguration](Test-CsLisConfiguration.md) - diff --git a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md index 7d4591b2d4..458d44b4aa 100644 --- a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance +online version: https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance applicable: Skype for Business Online title: Unregister-CsHybridPSTNAppliance schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Unregister-CsHybridPSTNAppliance @@ -171,4 +171,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Update-CsAddressBook.md b/skype/skype-ps/skype/Update-CsAddressBook.md index 850bcf9a93..3db49c7148 100644 --- a/skype/skype-ps/skype/Update-CsAddressBook.md +++ b/skype/skype-ps/skype/Update-CsAddressBook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csaddressbook +online version: https://learn.microsoft.com/powershell/module/skype/update-csaddressbook applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Update-CsAddressBook schema: 2.0.0 @@ -115,4 +115,3 @@ Instead, the Update-CsAddressBook cmdlet updates existing instances of the Micro [Test-CsAddressBookService](Test-CsAddressBookService.md) [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) - diff --git a/skype/skype-ps/skype/Update-CsAdminRole.md b/skype/skype-ps/skype/Update-CsAdminRole.md index 3cd90a0c2b..6b1a812753 100644 --- a/skype/skype-ps/skype/Update-CsAdminRole.md +++ b/skype/skype-ps/skype/Update-CsAdminRole.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csadminrole -applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +online version: https://learn.microsoft.com/powershell/module/skype/update-csadminrole +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Update-CsAdminRole schema: 2.0.0 manager: rogupta @@ -108,4 +108,3 @@ The Update-CsAdminRole cmdlet does not return any data or objects. ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Update-CsClsLogging.md b/skype/skype-ps/skype/Update-CsClsLogging.md index 6626ed1040..1478045d95 100644 --- a/skype/skype-ps/skype/Update-CsClsLogging.md +++ b/skype/skype-ps/skype/Update-CsClsLogging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csclslogging +online version: https://learn.microsoft.com/powershell/module/skype/update-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Update-CsClsLogging schema: 2.0.0 @@ -186,4 +186,3 @@ String value. [Stop-CsClsLogging](Stop-CsClsLogging.md) [Sync-CsClsLogging](Sync-CsClsLogging.md) - diff --git a/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md deleted file mode 100644 index af52830c92..0000000000 --- a/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csorganizationalautoattendant -applicable: Skype for Business Online -title: Update-CsOrganizationalAutoAttendant -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Update-CsOrganizationalAutoAttendant - -## SYNOPSIS -> [!CAUTION] -> This cmdlet has been deprecated and is no longer supported. -> -> Please use [Update-CsAutoAttendant](Update-CsAutoAttendant.md) cmdlet instead. diff --git a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md b/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md index 8956072ff9..03dc67a577 100644 --- a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md +++ b/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-cstenantmeetingurl +online version: https://learn.microsoft.com/powershell/module/skype/update-cstenantmeetingurl applicable: Skype for Business Online title: Update-CsTenantMeetingUrl schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Update-CsTenantMeetingUrl @@ -28,18 +28,18 @@ The `Update-CsTenantMeetingUrl` updates the Skype for Business Online meeting UR For example, suppose an organization sets up an Office 365 domain with the name contoso.onmicrosoft.com. When they do that, meetings will have URLs similar to this: -https://meet.lync.com/onmicrosoft/contoso/user1/45GZFH99 +`https://meet.lync.com/onmicrosoft/contoso/user1/45GZFH99` Now, suppose the organization undergoes some changes and decides to use the "vanity" URL litwareinc.com instead of the onmicrosoft.com URL. The organization modifies their user email addresses to use the litwareinc.com domain. However, meeting URLs will still use the old domain name: -https://meet.lync.com/contoso/user1/45GZFH99 +`https://meet.lync.com/contoso/user1/45GZFH99` To fix this problem, administrators should run the `Update-CsTenantMeetingUrl` cmdlet. That will replace the old meeting URL with a new one that features the vanity URL instead: -https://meet.lync.com/litwareinc.com/user1/37JYLP71 +`https://meet.lync.com/litwareinc.com/user1/37JYLP71` Running the `Update-CsTenantMeetingUrl` cmdlet is the only way to make this change. diff --git a/skype/skype-ps/skype/Update-CsUserData.md b/skype/skype-ps/skype/Update-CsUserData.md index c2ae02be50..1002d5a2b2 100644 --- a/skype/skype-ps/skype/Update-CsUserData.md +++ b/skype/skype-ps/skype/Update-CsUserData.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csuserdata +online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Update-CsUserData schema: 2.0.0 @@ -266,4 +266,3 @@ The Update-CsUserData cmdlet updates Skype for Business Server 2015 user informa [Import-CsUserData](Import-CsUserData.md) [Sync-CsUserData](Sync-CsUserData.md) - diff --git a/skype/skype-ps/skype/Update-CsUserDatabase.md b/skype/skype-ps/skype/Update-CsUserDatabase.md index eb8555e408..e4b3514b60 100644 --- a/skype/skype-ps/skype/Update-CsUserDatabase.md +++ b/skype/skype-ps/skype/Update-CsUserDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csuserdatabase +online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Update-CsUserDatabase schema: 2.0.0 @@ -110,4 +110,3 @@ Instead, the `Update-CsUserDatabase` cmdlet updates instances of the Microsoft.R [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) - diff --git a/skype/skype-ps/skype/skype.md b/skype/skype-ps/skype/skype.md index 89c01c9276..54e242ca7d 100644 --- a/skype/skype-ps/skype/skype.md +++ b/skype/skype-ps/skype/skype.md @@ -2,7 +2,6 @@ Module Name: SkypeForBusiness Module Guid: 01dfdcd9-c48d-46a9-b09a-587ca5c4829a Help Version: 17.0.15229.2100 -Download Help Link: https://officedocs-cdn.azureedge.net/powershell/skype/ title: skype Additional Locale: de-DE,es-ES,fr-FR,it-IT,ja-JP,ko-KR,pt-BR,ru-RU,zh-CN,zh-TW de-DE Version: 17.0.15229.2100 @@ -17,3320 +16,893 @@ zh-CN Version: 17.0.15229.2100 zh-TW Version: 17.0.15229.2100 --- -# Skype for Business PowerShell +# Skype for Business Server PowerShell ## Description -The following cmdlet references are for Skype for Business and Microsoft Teams. You can find information on installing the module for Skype for Business Online here: https://docs.microsoft.com/office365/enterprise/powershell/manage-skype-for-business-online-with-office-365-powershell. If you are using Skype for Business Server then the cmdlets are available in the Skype for Business Server Management Shell and you can find information about it here: https://docs.microsoft.com/skypeforbusiness/manage/management-shell. +The following cmdlet references are for Skype for Business Server Management Shell and you can find information about it here: https://learn.microsoft.com/skypeforbusiness/manage/management-shell. -## Skype for Business Cmdlets +## Skype for Business Server Cmdlets ### [Add-CsSlaDelegates](Add-CsSlaDelegates.md) -{{Manually Enter Add-CsSlaDelegates Description Here}} - ### [Approve-CsDeviceUpdateRule](Approve-CsDeviceUpdateRule.md) -{{Manually Enter Approve-CsDeviceUpdateRule Description Here}} - ### [Backup-CsPool](Backup-CsPool.md) -{{Manually Enter Backup-CsPool Description Here}} - ### [Clear-CsDeviceUpdateFile](Clear-CsDeviceUpdateFile.md) -{{Manually Enter Clear-CsDeviceUpdateFile Description Here}} - ### [Clear-CsDeviceUpdateLog](Clear-CsDeviceUpdateLog.md) -{{Manually Enter Clear-CsDeviceUpdateLog Description Here}} - -### [Clear-CsOnlineTelephoneNumberReservation](Clear-CsOnlineTelephoneNumberReservation.md) -{{Manually Enter Clear-CsOnlineTelephoneNumberReservation Description Here}} - ### [Clear-CsPersistentChatRoom](Clear-CsPersistentChatRoom.md) -{{Manually Enter Clear-CsPersistentChatRoom Description Here}} - -### [Complete-CsCceApplianceRegistration](Complete-CsCceApplianceRegistration.md) -{{Manually Enter Complete-CsCceApplianceRegistration Description Here}} - -### [Complete-CsCceApplianceUnregistration](Complete-CsCceApplianceUnregistration.md) -{{Manually Enter Complete-CsCceApplianceUnregistration Description Here}} - ### [Convert-CsUserData](Convert-CsUserData.md) -{{Manually Enter Convert-CsUserData Description Here}} - -### [ConvertTo-JsonForPSWS](ConvertTo-JsonForPSWS.md) -{{Manually Enter ConvertTo-JsonForPSWS Description Here}} - ### [Copy-CsVoicePolicy](Copy-CsVoicePolicy.md) -{{Manually Enter Copy-CsVoicePolicy Description Here}} - ### [Debug-CsAddressBookReplication](Debug-CsAddressBookReplication.md) -{{Manually Enter Debug-CsAddressBookReplication Description Here}} - ### [Debug-CsDataConference](Debug-CsDataConference.md) -{{Manually Enter Debug-CsDataConference Description Here}} - ### [Debug-CsInterPoolReplication](Debug-CsInterPoolReplication.md) -{{Manually Enter Debug-CsInterPoolReplication Description Here}} - ### [Debug-CsIntraPoolReplication](Debug-CsIntraPoolReplication.md) -{{Manually Enter Debug-CsIntraPoolReplication Description Here}} - ### [Debug-CsLisConfiguration](Debug-CsLisConfiguration.md) -{{Manually Enter Debug-CsLisConfiguration Description Here}} - ### [Debug-CsStorageServiceFailures](Debug-CsStorageServiceFailures.md) -{{Manually Enter Debug-CsStorageServiceFailures Description Here}} - ### [Debug-CsUnifiedContactStore](Debug-CsUnifiedContactStore.md) -{{Manually Enter Debug-CsUnifiedContactStore Description Here}} - ### [Disable-CsAdDomain](Disable-CsAdDomain.md) -{{Manually Enter Disable-CsAdDomain Description Here}} - ### [Disable-CsAdForest](Disable-CsAdForest.md) -{{Manually Enter Disable-CsAdForest Description Here}} - ### [Disable-CsComputer](Disable-CsComputer.md) -{{Manually Enter Disable-CsComputer Description Here}} - ### [Disable-CsHostingProvider](Disable-CsHostingProvider.md) -{{Manually Enter Disable-CsHostingProvider Description Here}} - ### [Disable-CsMeetingRoom](Disable-CsMeetingRoom.md) -{{Manually Enter Disable-CsMeetingRoom Description Here}} - ### [Disable-CsOnlineDialInConferencingUser](Disable-CsOnlineDialInConferencingUser.md) -{{Manually Enter Disable-CsOnlineDialInConferencingUser Description Here}} - ### [Disable-CsPublicProvider](Disable-CsPublicProvider.md) -{{Manually Enter Disable-CsPublicProvider Description Here}} - ### [Disable-CsUser](Disable-CsUser.md) -{{Manually Enter Disable-CsUser Description Here}} - ### [Enable-CsAdDomain](Enable-CsAdDomain.md) -{{Manually Enter Enable-CsAdDomain Description Here}} - ### [Enable-CsAdForest](Enable-CsAdForest.md) -{{Manually Enter Enable-CsAdForest Description Here}} - ### [Enable-CsComputer](Enable-CsComputer.md) -{{Manually Enter Enable-CsComputer Description Here}} - ### [Enable-CsHostingProvider](Enable-CsHostingProvider.md) -{{Manually Enter Enable-CsHostingProvider Description Here}} - ### [Enable-CsMeetingRoom](Enable-CsMeetingRoom.md) -{{Manually Enter Enable-CsMeetingRoom Description Here}} - -### [Enable-CsOnlineDialInConferencingUser](Enable-CsOnlineDialInConferencingUser.md) -{{Manually Enter Enable-CsOnlineDialInConferencingUser Description Here}} - ### [Enable-CsPublicProvider](Enable-CsPublicProvider.md) -{{Manually Enter Enable-CsPublicProvider Description Here}} - ### [Enable-CsReplica](Enable-CsReplica.md) -{{Manually Enter Enable-CsReplica Description Here}} - ### [Enable-CsTopology](Enable-CsTopology.md) -{{Manually Enter Enable-CsTopology Description Here}} - ### [Enable-CsUser](Enable-CsUser.md) -{{Manually Enter Enable-CsUser Description Here}} - ### [Export-CsArchivingData](Export-CsArchivingData.md) -{{Manually Enter Export-CsArchivingData Description Here}} - ### [Export-CsConfiguration](Export-CsConfiguration.md) -{{Manually Enter Export-CsConfiguration Description Here}} - ### [Export-CsLisConfiguration](Export-CsLisConfiguration.md) -{{Manually Enter Export-CsLisConfiguration Description Here}} - ### [Export-CsPersistentChatData](Export-CsPersistentChatData.md) -{{Manually Enter Export-CsPersistentChatData Description Here}} - ### [Export-CsRgsConfiguration](Export-CsRgsConfiguration.md) -{{Manually Enter Export-CsRgsConfiguration Description Here}} - ### [Export-CsUserData](Export-CsUserData.md) -{{Manually Enter Export-CsUserData Description Here}} - -### [Find-CsGroup](Find-CsGroup.md) -{{Manually Enter Find-CsGroup Description Here}} - ### [Get-CsAccessEdgeConfiguration](Get-CsAccessEdgeConfiguration.md) -{{Manually Enter Get-CsAccessEdgeConfiguration Description Here}} - ### [Get-CsAdContact](Get-CsAdContact.md) -{{Manually Enter Get-CsAdContact Description Here}} - +### [Get-CsAdditionalInternalDomain](Get-CsAdditionalInternalDomain.md) ### [Get-CsAdDomain](Get-CsAdDomain.md) -{{Manually Enter Get-CsAdDomain Description Here}} - ### [Get-CsAddressBookConfiguration](Get-CsAddressBookConfiguration.md) -{{Manually Enter Get-CsAddressBookConfiguration Description Here}} - ### [Get-CsAddressBookNormalizationConfiguration](Get-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter Get-CsAddressBookNormalizationConfiguration Description Here}} - ### [Get-CsAddressBookNormalizationRule](Get-CsAddressBookNormalizationRule.md) -{{Manually Enter Get-CsAddressBookNormalizationRule Description Here}} - ### [Get-CsAdForest](Get-CsAdForest.md) -{{Manually Enter Get-CsAdForest Description Here}} - ### [Get-CsAdminRole](Get-CsAdminRole.md) -{{Manually Enter Get-CsAdminRole Description Here}} - ### [Get-CsAdminRoleAssignment](Get-CsAdminRoleAssignment.md) -{{Manually Enter Get-CsAdminRoleAssignment Description Here}} - ### [Get-CsAdPrincipal](Get-CsAdPrincipal.md) -{{Manually Enter Get-CsAdPrincipal Description Here}} - ### [Get-CsAdServerSchema](Get-CsAdServerSchema.md) -{{Manually Enter Get-CsAdServerSchema Description Here}} - ### [Get-CsAdUser](Get-CsAdUser.md) -{{Manually Enter Get-CsAdUser Description Here}} - ### [Get-CsAllowedDomain](Get-CsAllowedDomain.md) -{{Manually Enter Get-CsAllowedDomain Description Here}} - ### [Get-CsAnalogDevice](Get-CsAnalogDevice.md) -{{Manually Enter Get-CsAnalogDevice Description Here}} - ### [Get-CsAnnouncement](Get-CsAnnouncement.md) -{{Manually Enter Get-CsAnnouncement Description Here}} - ### [Get-CsApplicationEndpoint](Get-CsApplicationEndpoint.md) -{{Manually Enter Get-CsApplicationEndpoint Description Here}} - ### [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) -{{Manually Enter Get-CsArchivingConfiguration Description Here}} - ### [Get-CsArchivingPolicy](Get-CsArchivingPolicy.md) -{{Manually Enter Get-CsArchivingPolicy Description Here}} - -### [Get-CsAudioConferencingProvider](Get-CsAudioConferencingProvider.md) -{{Manually Enter Get-CsAudioConferencingProvider Description Here}} - ### [Get-CsAudioTestServiceApplication](Get-CsAudioTestServiceApplication.md) -{{Manually Enter Get-CsAudioTestServiceApplication Description Here}} - +### [Get-CsAuthConfig](Get-CsAuthConfig.md) ### [Get-CsAutodiscoverConfiguration](Get-CsAutodiscoverConfiguration.md) -{{Manually Enter Get-CsAutodiscoverConfiguration Description Here}} - ### [Get-CsAVEdgeConfiguration](Get-CsAVEdgeConfiguration.md) -{{Manually Enter Get-CsAVEdgeConfiguration Description Here}} - ### [Get-CsBackupServiceConfiguration](Get-CsBackupServiceConfiguration.md) -{{Manually Enter Get-CsBackupServiceConfiguration Description Here}} - ### [Get-CsBackupServiceStatus](Get-CsBackupServiceStatus.md) -{{Manually Enter Get-CsBackupServiceStatus Description Here}} - ### [Get-CsBandwidthPolicyServiceConfiguration](Get-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter Get-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [Get-CsBlockedDomain](Get-CsBlockedDomain.md) -{{Manually Enter Get-CsBlockedDomain Description Here}} - -### [Get-CsBroadcastMeetingConfiguration](Get-CsBroadcastMeetingConfiguration.md) -{{Manually Enter Get-CsBroadcastMeetingConfiguration Description Here}} - -### [Get-CsBroadcastMeetingPolicy](Get-CsBroadcastMeetingPolicy.md) -{{Manually Enter Get-CsBroadcastMeetingPolicy Description Here}} - ### [Get-CsBusyOptions](Get-CsBusyOptions.md) -{{Manually Enter Get-CsBusyOptions Description Here}} - -### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) -{{Manually Enter Get-CsCallingLineIdentity Description Here}} - ### [Get-CsCallParkOrbit](Get-CsCallParkOrbit.md) -{{Manually Enter Get-CsCallParkOrbit Description Here}} - ### [Get-CsCallViaWorkPolicy](Get-CsCallViaWorkPolicy.md) -{{Manually Enter Get-CsCallViaWorkPolicy Description Here}} - ### [Get-CsCdrConfiguration](Get-CsCdrConfiguration.md) -{{Manually Enter Get-CsCdrConfiguration Description Here}} - ### [Get-CsCertificate](Get-CsCertificate.md) -{{Manually Enter Get-CsCertificate Description Here}} - ### [Get-CsClientAccessLicense](Get-CsClientAccessLicense.md) -{{Manually Enter Get-CsClientAccessLicense Description Here}} - ### [Get-CsClientCertificate](Get-CsClientCertificate.md) -{{Manually Enter Get-CsClientCertificate Description Here}} - ### [Get-CsClientPinInfo](Get-CsClientPinInfo.md) -{{Manually Enter Get-CsClientPinInfo Description Here}} - ### [Get-CsClientPolicy](Get-CsClientPolicy.md) -{{Manually Enter Get-CsClientPolicy Description Here}} - ### [Get-CsClientVersionConfiguration](Get-CsClientVersionConfiguration.md) -{{Manually Enter Get-CsClientVersionConfiguration Description Here}} - ### [Get-CsClientVersionPolicy](Get-CsClientVersionPolicy.md) -{{Manually Enter Get-CsClientVersionPolicy Description Here}} - ### [Get-CsClientVersionPolicyRule](Get-CsClientVersionPolicyRule.md) -{{Manually Enter Get-CsClientVersionPolicyRule Description Here}} - -### [Get-CsCloudMeetingPolicy](Get-CsCloudMeetingPolicy.md) -{{Manually Enter Get-CsCloudMeetingPolicy Description Here}} - +### [Get-CsCloudCallDataConnector](Get-CsCloudCallDataConnector.md) +### [Get-CsCloudCallDataConnectorConfiguration](Get-CsCloudCallDataConnectorConfiguration.md) ### [Get-CsClsAgentStatus](Get-CsClsAgentStatus.md) -{{Manually Enter Get-CsClsAgentStatus Description Here}} - ### [Get-CsClsConfiguration](Get-CsClsConfiguration.md) -{{Manually Enter Get-CsClsConfiguration Description Here}} - ### [Get-CsClsRegion](Get-CsClsRegion.md) -{{Manually Enter Get-CsClsRegion Description Here}} - ### [Get-CsClsScenario](Get-CsClsScenario.md) -{{Manually Enter Get-CsClsScenario Description Here}} - ### [Get-CsClsSearchTerm](Get-CsClsSearchTerm.md) -{{Manually Enter Get-CsClsSearchTerm Description Here}} - ### [Get-CsClsSecurityGroup](Get-CsClsSecurityGroup.md) -{{Manually Enter Get-CsClsSecurityGroup Description Here}} - ### [Get-CsCommonAreaPhone](Get-CsCommonAreaPhone.md) -{{Manually Enter Get-CsCommonAreaPhone Description Here}} - ### [Get-CsComputer](Get-CsComputer.md) -{{Manually Enter Get-CsComputer Description Here}} - ### [Get-CsConferenceDirectory](Get-CsConferenceDirectory.md) -{{Manually Enter Get-CsConferenceDirectory Description Here}} - ### [Get-CsConferenceDisclaimer](Get-CsConferenceDisclaimer.md) -{{Manually Enter Get-CsConferenceDisclaimer Description Here}} - ### [Get-CsConferencingConfiguration](Get-CsConferencingConfiguration.md) -{{Manually Enter Get-CsConferencingConfiguration Description Here}} - ### [Get-CsConferencingPolicy](Get-CsConferencingPolicy.md) -{{Manually Enter Get-CsConferencingPolicy Description Here}} - ### [Get-CsConfigurationStoreLocation](Get-CsConfigurationStoreLocation.md) -{{Manually Enter Get-CsConfigurationStoreLocation Description Here}} - ### [Get-CsConversationHistoryConfiguration](Get-CsConversationHistoryConfiguration.md) -{{Manually Enter Get-CsConversationHistoryConfiguration Description Here}} - ### [Get-CsCpsConfiguration](Get-CsCpsConfiguration.md) -{{Manually Enter Get-CsCpsConfiguration Description Here}} - ### [Get-CsDatabaseMirrorState](Get-CsDatabaseMirrorState.md) -{{Manually Enter Get-CsDatabaseMirrorState Description Here}} - ### [Get-CsDeviceUpdateConfiguration](Get-CsDeviceUpdateConfiguration.md) -{{Manually Enter Get-CsDeviceUpdateConfiguration Description Here}} - ### [Get-CsDeviceUpdateRule](Get-CsDeviceUpdateRule.md) -{{Manually Enter Get-CsDeviceUpdateRule Description Here}} - ### [Get-CsDiagnosticConfiguration](Get-CsDiagnosticConfiguration.md) -{{Manually Enter Get-CsDiagnosticConfiguration Description Here}} - ### [Get-CsDiagnosticHeaderConfiguration](Get-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter Get-CsDiagnosticHeaderConfiguration Description Here}} - ### [Get-CsDialInConferencingAccessNumber](Get-CsDialInConferencingAccessNumber.md) -{{Manually Enter Get-CsDialInConferencingAccessNumber Description Here}} - ### [Get-CsDialInConferencingConfiguration](Get-CsDialInConferencingConfiguration.md) -{{Manually Enter Get-CsDialInConferencingConfiguration Description Here}} - ### [Get-CsDialInConferencingDtmfConfiguration](Get-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter Get-CsDialInConferencingDtmfConfiguration Description Here}} - ### [Get-CsDialInConferencingLanguageList](Get-CsDialInConferencingLanguageList.md) -{{Manually Enter Get-CsDialInConferencingLanguageList Description Here}} - ### [Get-CsDialPlan](Get-CsDialPlan.md) -{{Manually Enter Get-CsDialPlan Description Here}} - ### [Get-CsEffectivePolicy](Get-CsEffectivePolicy.md) -{{Manually Enter Get-CsEffectivePolicy Description Here}} - -### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) -{{Manually Enter Get-CsEffectiveTenantDialPlan Description Here}} - ### [Get-CsEnhancedEmergencyServiceDisclaimer](Get-CsEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Get-CsEnhancedEmergencyServiceDisclaimer Description Here}} - ### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) -{{Manually Enter Get-CsExternalAccessPolicy Description Here}} - -### [Get-CsExternalUserCommunicationPolicy](Get-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Get-CsExternalUserCommunicationPolicy Description Here}} - ### [Get-CsExUmContact](Get-CsExUmContact.md) -{{Manually Enter Get-CsExUmContact Description Here}} - ### [Get-CsFileTransferFilterConfiguration](Get-CsFileTransferFilterConfiguration.md) -{{Manually Enter Get-CsFileTransferFilterConfiguration Description Here}} - ### [Get-CsFIPSConfiguration](Get-CsFIPSConfiguration.md) -{{Manually Enter Get-CsFIPSConfiguration Description Here}} - -### [Get-CsGraphPolicy](Get-CsGraphPolicy.md) -{{Manually Enter Get-CsGraphPolicy Description Here}} - ### [Get-CsGroupPickupUserOrbit](Get-CsGroupPickupUserOrbit.md) -{{Manually Enter Get-CsGroupPickupUserOrbit Description Here}} - ### [Get-CsHealthMonitoringConfiguration](Get-CsHealthMonitoringConfiguration.md) -{{Manually Enter Get-CsHealthMonitoringConfiguration Description Here}} - ### [Get-CsHostedVoicemailPolicy](Get-CsHostedVoicemailPolicy.md) -{{Manually Enter Get-CsHostedVoicemailPolicy Description Here}} - ### [Get-CsHostingProvider](Get-CsHostingProvider.md) -{{Manually Enter Get-CsHostingProvider Description Here}} - -### [Get-CsHuntGroup](Get-CsHuntGroup.md) -{{Manually Enter Get-CsHuntGroup Description Here}} - -### [Get-CsHuntGroupTenantInformation](Get-CsHuntGroupTenantInformation.md) -{{Manually Enter Get-CsHuntGroupTenantInformation Description Here}} - -### [Get-CsHybridMediationServer](Get-CsHybridMediationServer.md) -{{Manually Enter Get-CsHybridMediationServer Description Here}} - -### [Get-CsHybridPSTNAppliance](Get-CsHybridPSTNAppliance.md) -{{Manually Enter Get-CsHybridPSTNAppliance Description Here}} - -### [Get-CsHybridPSTNSite](Get-CsHybridPSTNSite.md) -{{Manually Enter Get-CsHybridPSTNSite Description Here}} - +### [Get-CsHybridApplicationEndpoint](Get-CsHybridApplicationEndpoint.md) ### [Get-CsImConfiguration](Get-CsImConfiguration.md) -{{Manually Enter Get-CsImConfiguration Description Here}} - ### [Get-CsImFilterConfiguration](Get-CsImFilterConfiguration.md) -{{Manually Enter Get-CsImFilterConfiguration Description Here}} - ### [Get-CsImTranslationConfiguration](Get-CsImTranslationConfiguration.md) -{{Manually Enter Get-CsImTranslationConfiguration Description Here}} - ### [Get-CsIPPhonePolicy](Get-CsIPPhonePolicy.md) -{{Manually Enter Get-CsIPPhonePolicy Description Here}} - ### [Get-CsKerberosAccountAssignment](Get-CsKerberosAccountAssignment.md) -{{Manually Enter Get-CsKerberosAccountAssignment Description Here}} - ### [Get-CsLisCivicAddress](Get-CsLisCivicAddress.md) -{{Manually Enter Get-CsLisCivicAddress Description Here}} - ### [Get-CsLisLocation](Get-CsLisLocation.md) -{{Manually Enter Get-CsLisLocation Description Here}} - ### [Get-CsLisPort](Get-CsLisPort.md) -{{Manually Enter Get-CsLisPort Description Here}} - ### [Get-CsLisServiceProvider](Get-CsLisServiceProvider.md) -{{Manually Enter Get-CsLisServiceProvider Description Here}} - ### [Get-CsLisSubnet](Get-CsLisSubnet.md) -{{Manually Enter Get-CsLisSubnet Description Here}} - ### [Get-CsLisSwitch](Get-CsLisSwitch.md) -{{Manually Enter Get-CsLisSwitch Description Here}} - ### [Get-CsLisWirelessAccessPoint](Get-CsLisWirelessAccessPoint.md) -{{Manually Enter Get-CsLisWirelessAccessPoint Description Here}} - ### [Get-CsLocationPolicy](Get-CsLocationPolicy.md) -{{Manually Enter Get-CsLocationPolicy Description Here}} - ### [Get-CsManagementConnection](Get-CsManagementConnection.md) -{{Manually Enter Get-CsManagementConnection Description Here}} - ### [Get-CsManagementStoreReplicationStatus](Get-CsManagementStoreReplicationStatus.md) -{{Manually Enter Get-CsManagementStoreReplicationStatus Description Here}} - ### [Get-CsMcxConfiguration](Get-CsMcxConfiguration.md) -{{Manually Enter Get-CsMcxConfiguration Description Here}} - ### [Get-CsMediaConfiguration](Get-CsMediaConfiguration.md) -{{Manually Enter Get-CsMediaConfiguration Description Here}} - ### [Get-CsMeetingConfiguration](Get-CsMeetingConfiguration.md) -{{Manually Enter Get-CsMeetingConfiguration Description Here}} - -### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) -{{Manually Enter Get-CsMeetingMigrationStatus Description Here}} - ### [Get-CsMeetingRoom](Get-CsMeetingRoom.md) -{{Manually Enter Get-CsMeetingRoom Description Here}} - ### [Get-CsMobilityPolicy](Get-CsMobilityPolicy.md) -{{Manually Enter Get-CsMobilityPolicy Description Here}} - ### [Get-CsNetworkBandwidthPolicyProfile](Get-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter Get-CsNetworkBandwidthPolicyProfile Description Here}} - ### [Get-CsNetworkConfiguration](Get-CsNetworkConfiguration.md) -{{Manually Enter Get-CsNetworkConfiguration Description Here}} - ### [Get-CsNetworkInterface](Get-CsNetworkInterface.md) -{{Manually Enter Get-CsNetworkInterface Description Here}} - ### [Get-CsNetworkInterRegionRoute](Get-CsNetworkInterRegionRoute.md) -{{Manually Enter Get-CsNetworkInterRegionRoute Description Here}} - ### [Get-CsNetworkInterSitePolicy](Get-CsNetworkInterSitePolicy.md) -{{Manually Enter Get-CsNetworkInterSitePolicy Description Here}} - ### [Get-CsNetworkRegion](Get-CsNetworkRegion.md) -{{Manually Enter Get-CsNetworkRegion Description Here}} - ### [Get-CsNetworkRegionLink](Get-CsNetworkRegionLink.md) -{{Manually Enter Get-CsNetworkRegionLink Description Here}} - ### [Get-CsNetworkSite](Get-CsNetworkSite.md) -{{Manually Enter Get-CsNetworkSite Description Here}} - ### [Get-CsNetworkSubnet](Get-CsNetworkSubnet.md) -{{Manually Enter Get-CsNetworkSubnet Description Here}} - ### [Get-CsOAuthConfiguration](Get-CsOAuthConfiguration.md) -{{Manually Enter Get-CsOAuthConfiguration Description Here}} - ### [Get-CsOAuthServer](Get-CsOAuthServer.md) -{{Manually Enter Get-CsOAuthServer Description Here}} - -### [Get-CsOnlineApplicationEndpoint](Get-CsOnlineApplicationEndpoint.md) -{{Manually Enter Get-CsOnlineApplicationEndpoint Description Here}} - ### [Get-CsOnlineDialInConferencingBridge](Get-CsOnlineDialInConferencingBridge.md) -{{Manually Enter Get-CsOnlineDialInConferencingBridge Description Here}} - ### [Get-CsOnlineDialInConferencingLanguagesSupported](Get-CsOnlineDialInConferencingLanguagesSupported.md) -{{Manually Enter Get-CsOnlineDialInConferencingLanguagesSupported Description Here}} - -### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) -{{Manually Enter Get-CsOnlineDialinConferencingPolicy Description Here}} - -### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Get-CsOnlineDialInConferencingServiceNumber Description Here}} - -### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) -{{Manually Enter Get-CsOnlineDialinConferencingTenantConfiguration Description Here}} - -### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) -{{Manually Enter Get-CsOnlineDialInConferencingTenantSettings Description Here}} - -### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) -{{Manually Enter Get-CsOnlineDialInConferencingUser Description Here}} - ### [Get-CsOnlineDialInConferencingUserInfo](Get-CsOnlineDialInConferencingUserInfo.md) -{{Manually Enter Get-CsOnlineDialInConferencingUserInfo Description Here}} - ### [Get-CsOnlineDialInConferencingUserState](Get-CsOnlineDialInConferencingUserState.md) -{{Manually Enter Get-CsOnlineDialInConferencingUserState Description Here}} - -### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) -{{Manually Enter Get-CsOnlineDialOutPolicy Description Here}} - -### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) -{{Manually Enter Get-CsOnlineDirectoryTenant Description Here}} - -### [Get-CsOnlineDirectoryTenantNumberCities](Get-CsOnlineDirectoryTenantNumberCities.md) -{{Manually Enter Get-CsOnlineDirectoryTenantNumberCities Description Here}} - -### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Get-CsOnlineEnhancedEmergencyServiceDisclaimer Description Here}} - -### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) -{{Manually Enter Get-CsOnlineLisCivicAddress Description Here}} - -### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) -{{Manually Enter Get-CsOnlineLisLocation Description Here}} - ### [Get-CsOnlineNumberPortInOrder](Get-CsOnlineNumberPortInOrder.md) -{{Manually Enter Get-CsOnlineNumberPortInOrder Description Here}} - ### [Get-CsOnlineNumberPortOutOrderPin](Get-CsOnlineNumberPortOutOrderPin.md) -{{Manually Enter Get-CsOnlineNumberPortOutOrderPin Description Here}} - -### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) -{{Manually Enter Get-CsOnlinePSTNGateway Description Here}} - -### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) -{{Manually Enter Get-CsOnlineTelephoneNumber Description Here}} - -### [Get-CsOnlineTelephoneNumberAvailableCount](Get-CsOnlineTelephoneNumberAvailableCount.md) -{{Manually Enter Get-CsOnlineTelephoneNumberAvailableCount Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryAreas](Get-CsOnlineTelephoneNumberInventoryAreas.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryAreas Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryCities](Get-CsOnlineTelephoneNumberInventoryCities.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryCities Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryCountries](Get-CsOnlineTelephoneNumberInventoryCountries.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryCountries Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryRegions](Get-CsOnlineTelephoneNumberInventoryRegions.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryRegions Description Here}} - -### [Get-CsOnlineTelephoneNumberInventoryTypes](Get-CsOnlineTelephoneNumberInventoryTypes.md) -{{Manually Enter Get-CsOnlineTelephoneNumberInventoryTypes Description Here}} - -### [Get-CsOnlineTelephoneNumberReservationsInformation](Get-CsOnlineTelephoneNumberReservationsInformation.md) -{{Manually Enter Get-CsOnlineTelephoneNumberReservationsInformation Description Here}} - -### [Get-CsOnlineUser](Get-CsOnlineUser.md) -{{Manually Enter Get-CsOnlineUser Description Here}} - -### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) -{{Manually Enter Get-CsOnlineVoicemailPolicy Description Here}} - -### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) -{{Manually Enter Get-CsOnlineVoiceUser Description Here}} - -### [Get-CsOrganizationalAutoAttendant](Get-CsOrganizationalAutoAttendant.md) -{{Manually Enter Get-CsOrganizationalAutoAttendant Description Here}} - -### [Get-CsOrganizationalAutoAttendantStatus](Get-CsOrganizationalAutoAttendantStatus.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantStatus Description Here}} - -### [Get-CsOrganizationalAutoAttendantSupportedLanguage](Get-CsOrganizationalAutoAttendantSupportedLanguage.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantSupportedLanguage Description Here}} - -### [Get-CsOrganizationalAutoAttendantSupportedTimeZone](Get-CsOrganizationalAutoAttendantSupportedTimeZone.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantSupportedTimeZone Description Here}} - -### [Get-CsOrganizationalAutoAttendantTenantInformation](Get-CsOrganizationalAutoAttendantTenantInformation.md) -{{Manually Enter Get-CsOrganizationalAutoAttendantTenantInformation Description Here}} - ### [Get-CsOutboundCallingNumberTranslationRule](Get-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter Get-CsOutboundCallingNumberTranslationRule Description Here}} - ### [Get-CsOutboundTranslationRule](Get-CsOutboundTranslationRule.md) -{{Manually Enter Get-CsOutboundTranslationRule Description Here}} - ### [Get-CsPartnerApplication](Get-CsPartnerApplication.md) -{{Manually Enter Get-CsPartnerApplication Description Here}} - ### [Get-CsPersistentChatAddin](Get-CsPersistentChatAddin.md) -{{Manually Enter Get-CsPersistentChatAddin Description Here}} - ### [Get-CsPersistentChatCategory](Get-CsPersistentChatCategory.md) -{{Manually Enter Get-CsPersistentChatCategory Description Here}} - ### [Get-CsPersistentChatComplianceConfiguration](Get-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter Get-CsPersistentChatComplianceConfiguration Description Here}} - ### [Get-CsPersistentChatConfiguration](Get-CsPersistentChatConfiguration.md) -{{Manually Enter Get-CsPersistentChatConfiguration Description Here}} - ### [Get-CsPersistentChatEligiblePrincipal](Get-CsPersistentChatEligiblePrincipal.md) -{{Manually Enter Get-CsPersistentChatEligiblePrincipal Description Here}} - ### [Get-CsPersistentChatEndpoint](Get-CsPersistentChatEndpoint.md) -{{Manually Enter Get-CsPersistentChatEndpoint Description Here}} - ### [Get-CsPersistentChatPolicy](Get-CsPersistentChatPolicy.md) -{{Manually Enter Get-CsPersistentChatPolicy Description Here}} - ### [Get-CsPersistentChatRoom](Get-CsPersistentChatRoom.md) -{{Manually Enter Get-CsPersistentChatRoom Description Here}} - ### [Get-CsPersistentChatState](Get-CsPersistentChatState.md) -{{Manually Enter Get-CsPersistentChatState Description Here}} - ### [Get-CsPinPolicy](Get-CsPinPolicy.md) -{{Manually Enter Get-CsPinPolicy Description Here}} - +### [Get-CsPlatformServiceSettings](Get-CsPlatformServiceSettings.md) ### [Get-CsPool](Get-CsPool.md) -{{Manually Enter Get-CsPool Description Here}} - ### [Get-CsPoolBackupRelationship](Get-CsPoolBackupRelationship.md) -{{Manually Enter Get-CsPoolBackupRelationship Description Here}} - ### [Get-CsPoolFabricState](Get-CsPoolFabricState.md) -{{Manually Enter Get-CsPoolFabricState Description Here}} - ### [Get-CsPoolUpgradeReadinessState](Get-CsPoolUpgradeReadinessState.md) -{{Manually Enter Get-CsPoolUpgradeReadinessState Description Here}} - ### [Get-CsPresenceManagementState](Get-CsPresenceManagementState.md) -{{Manually Enter Get-CsPresenceManagementState Description Here}} - ### [Get-CsPresencePolicy](Get-CsPresencePolicy.md) -{{Manually Enter Get-CsPresencePolicy Description Here}} - ### [Get-CsPresenceProvider](Get-CsPresenceProvider.md) -{{Manually Enter Get-CsPresenceProvider Description Here}} - ### [Get-CsPrivacyConfiguration](Get-CsPrivacyConfiguration.md) -{{Manually Enter Get-CsPrivacyConfiguration Description Here}} - ### [Get-CsProxyConfiguration](Get-CsProxyConfiguration.md) -{{Manually Enter Get-CsProxyConfiguration Description Here}} - ### [Get-CsPstnUsage](Get-CsPstnUsage.md) -{{Manually Enter Get-CsPstnUsage Description Here}} - ### [Get-CsPublicProvider](Get-CsPublicProvider.md) -{{Manually Enter Get-CsPublicProvider Description Here}} - ### [Get-CsPushNotificationConfiguration](Get-CsPushNotificationConfiguration.md) -{{Manually Enter Get-CsPushNotificationConfiguration Description Here}} - ### [Get-CsQoEConfiguration](Get-CsQoEConfiguration.md) -{{Manually Enter Get-CsQoEConfiguration Description Here}} - ### [Get-CsRegistrarConfiguration](Get-CsRegistrarConfiguration.md) -{{Manually Enter Get-CsRegistrarConfiguration Description Here}} - ### [Get-CsReportingConfiguration](Get-CsReportingConfiguration.md) -{{Manually Enter Get-CsReportingConfiguration Description Here}} - ### [Get-CsRgsAgentGroup](Get-CsRgsAgentGroup.md) -{{Manually Enter Get-CsRgsAgentGroup Description Here}} - ### [Get-CsRgsConfiguration](Get-CsRgsConfiguration.md) -{{Manually Enter Get-CsRgsConfiguration Description Here}} - ### [Get-CsRgsHolidaySet](Get-CsRgsHolidaySet.md) -{{Manually Enter Get-CsRgsHolidaySet Description Here}} - ### [Get-CsRgsHoursOfBusiness](Get-CsRgsHoursOfBusiness.md) -{{Manually Enter Get-CsRgsHoursOfBusiness Description Here}} - ### [Get-CsRgsQueue](Get-CsRgsQueue.md) -{{Manually Enter Get-CsRgsQueue Description Here}} - ### [Get-CsRgsWorkflow](Get-CsRgsWorkflow.md) -{{Manually Enter Get-CsRgsWorkflow Description Here}} - ### [Get-CsRoutingConfiguration](Get-CsRoutingConfiguration.md) -{{Manually Enter Get-CsRoutingConfiguration Description Here}} - ### [Get-CsServerApplication](Get-CsServerApplication.md) -{{Manually Enter Get-CsServerApplication Description Here}} - ### [Get-CsServerPatchVersion](Get-CsServerPatchVersion.md) -{{Manually Enter Get-CsServerPatchVersion Description Here}} - ### [Get-CsServerVersion](Get-CsServerVersion.md) -{{Manually Enter Get-CsServerVersion Description Here}} - ### [Get-CsService](Get-CsService.md) -{{Manually Enter Get-CsService Description Here}} - ### [Get-CsSimpleUrlConfiguration](Get-CsSimpleUrlConfiguration.md) -{{Manually Enter Get-CsSimpleUrlConfiguration Description Here}} - ### [Get-CsSipDomain](Get-CsSipDomain.md) -{{Manually Enter Get-CsSipDomain Description Here}} - ### [Get-CsSipResponseCodeTranslationRule](Get-CsSipResponseCodeTranslationRule.md) -{{Manually Enter Get-CsSipResponseCodeTranslationRule Description Here}} - ### [Get-CsSite](Get-CsSite.md) -{{Manually Enter Get-CsSite Description Here}} - ### [Get-CsSlaConfiguration](Get-CsSlaConfiguration.md) -{{Manually Enter Get-CsSlaConfiguration Description Here}} - ### [Get-CsStaticRoutingConfiguration](Get-CsStaticRoutingConfiguration.md) -{{Manually Enter Get-CsStaticRoutingConfiguration Description Here}} - ### [Get-CsStorageServiceConfiguration](Get-CsStorageServiceConfiguration.md) -{{Manually Enter Get-CsStorageServiceConfiguration Description Here}} - -### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) -{{Manually Enter Get-CsTeamsCallingPolicy Description Here}} - -### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) -{{Manually Enter Get-CsTeamsMobilityPolicy Description Here}} - -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) -{{Manually Enter Get-CsTeamsMeetingPolicy Description Here}} - +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) ### [Get-CsTelemetryConfiguration](Get-CsTelemetryConfiguration.md) -{{Manually Enter Get-CsTelemetryConfiguration Description Here}} - -### [Get-CsTenant](Get-CsTenant.md) -{{Manually Enter Get-CsTenant Description Here}} - -### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) -{{Manually Enter Get-CsTenantDialPlan Description Here}} - -### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) -{{Manually Enter Get-CsTenantFederationConfiguration Description Here}} - ### [Get-CsTenantHybridConfiguration](Get-CsTenantHybridConfiguration.md) -{{Manually Enter Get-CsTenantHybridConfiguration Description Here}} - -### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) -{{Manually Enter Get-CsTenantLicensingConfiguration Description Here}} - -### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) -{{Manually Enter Get-CsTenantMigrationConfiguration Description Here}} - -### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) -{{Manually Enter Get-CsTenantNetworkRegion Description Here}} - -### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) -{{Manually Enter Get-CsTenantNetworkSite Description Here}} - -### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) -{{Manually Enter Get-CsTenantNetworkSubnet Description Here}} - -### [Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) -{{Manually Enter Get-CsTenantPublicProvider Description Here}} - -### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) -{{Manually Enter Get-CsTenantTrustedIPAddress Description Here}} - -### [Get-CsTenantUpdateTimeWindow](Get-CsTenantUpdateTimeWindow.md) -{{Manually Enter Get-CsTenantUpdateTimeWindow Description Here}} - ### [Get-CsTestDevice](Get-CsTestDevice.md) -{{Manually Enter Get-CsTestDevice Description Here}} - ### [Get-CsTestUserCredential](Get-CsTestUserCredential.md) -{{Manually Enter Get-CsTestUserCredential Description Here}} - ### [Get-CsThirdPartyVideoSystem](Get-CsThirdPartyVideoSystem.md) -{{Manually Enter Get-CsThirdPartyVideoSystem Description Here}} - ### [Get-CsThirdPartyVideoSystemPolicy](Get-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Get-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Get-CsTopology](Get-CsTopology.md) -{{Manually Enter Get-CsTopology Description Here}} - ### [Get-CsTrunk](Get-CsTrunk.md) -{{Manually Enter Get-CsTrunk Description Here}} - ### [Get-CsTrunkConfiguration](Get-CsTrunkConfiguration.md) -{{Manually Enter Get-CsTrunkConfiguration Description Here}} - ### [Get-CsTrustedApplication](Get-CsTrustedApplication.md) -{{Manually Enter Get-CsTrustedApplication Description Here}} - ### [Get-CsTrustedApplicationComputer](Get-CsTrustedApplicationComputer.md) -{{Manually Enter Get-CsTrustedApplicationComputer Description Here}} - ### [Get-CsTrustedApplicationEndpoint](Get-CsTrustedApplicationEndpoint.md) -{{Manually Enter Get-CsTrustedApplicationEndpoint Description Here}} - ### [Get-CsTrustedApplicationPool](Get-CsTrustedApplicationPool.md) -{{Manually Enter Get-CsTrustedApplicationPool Description Here}} - ### [Get-CsUCPhoneConfiguration](Get-CsUCPhoneConfiguration.md) -{{Manually Enter Get-CsUCPhoneConfiguration Description Here}} - ### [Get-CsUICulture](Get-CsUICulture.md) -{{Manually Enter Get-CsUICulture Description Here}} - ### [Get-CsUnassignedNumber](Get-CsUnassignedNumber.md) -{{Manually Enter Get-CsUnassignedNumber Description Here}} - +### [Get-CsUpgradeDomainInfo](Get-CsUpgradeDomainInfo.md) ### [Get-CsUser](Get-CsUser.md) -{{Manually Enter Get-CsUser Description Here}} - ### [Get-CsUserAcp](Get-CsUserAcp.md) -{{Manually Enter Get-CsUserAcp Description Here}} - ### [Get-CsUserCallForwardingSettings](Get-CsUserCallForwardingSettings.md) -{{Manually Enter Get-CsUserCallForwardingSettings Description Here}} - ### [Get-CsUserDatabaseState](Get-CsUserDatabaseState.md) -{{Manually Enter Get-CsUserDatabaseState Description Here}} - ### [Get-CsUserDelegates](Get-CsUserDelegates.md) -{{Manually Enter Get-CsUserDelegates Description Here}} - -### [Get-CsUserLocationStatus](Get-CsUserLocationStatus.md) -{{Manually Enter Get-CsUserLocationStatus Description Here}} - ### [Get-CsUserPoolInfo](Get-CsUserPoolInfo.md) -{{Manually Enter Get-CsUserPoolInfo Description Here}} - -### [Get-CsUserPstnSettings](Get-CsUserPstnSettings.md) -{{Manually Enter Get-CsUserPstnSettings Description Here}} - ### [Get-CsUserReplicatorConfiguration](Get-CsUserReplicatorConfiguration.md) -{{Manually Enter Get-CsUserReplicatorConfiguration Description Here}} - ### [Get-CsUserServicesConfiguration](Get-CsUserServicesConfiguration.md) -{{Manually Enter Get-CsUserServicesConfiguration Description Here}} - ### [Get-CsUserServicesPolicy](Get-CsUserServicesPolicy.md) -{{Manually Enter Get-CsUserServicesPolicy Description Here}} - -### [Get-CsUserSession](Get-CsUserSession.md) -{{Manually Enter Get-CsUserSession Description Here}} - +### [Get-CsUserSettingsPageConfiguration](Get-CsUserSettingsPageConfiguration.md) ### [Get-CsUserTeamMembers](Get-CsUserTeamMembers.md) -{{Manually Enter Get-CsUserTeamMembers Description Here}} - ### [Get-CsVideoInteropServerConfiguration](Get-CsVideoInteropServerConfiguration.md) -{{Manually Enter Get-CsVideoInteropServerConfiguration Description Here}} - ### [Get-CsVideoInteropServerSyntheticTransactionConfiguration](Get-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter Get-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [Get-CsVideoTrunk](Get-CsVideoTrunk.md) -{{Manually Enter Get-CsVideoTrunk Description Here}} - ### [Get-CsVideoTrunkConfiguration](Get-CsVideoTrunkConfiguration.md) -{{Manually Enter Get-CsVideoTrunkConfiguration Description Here}} - ### [Get-CsVoiceConfiguration](Get-CsVoiceConfiguration.md) -{{Manually Enter Get-CsVoiceConfiguration Description Here}} - ### [Get-CsVoicemailReroutingConfiguration](Get-CsVoicemailReroutingConfiguration.md) -{{Manually Enter Get-CsVoicemailReroutingConfiguration Description Here}} - ### [Get-CsVoiceNormalizationRule](Get-CsVoiceNormalizationRule.md) -{{Manually Enter Get-CsVoiceNormalizationRule Description Here}} - ### [Get-CsVoicePolicy](Get-CsVoicePolicy.md) -{{Manually Enter Get-CsVoicePolicy Description Here}} - ### [Get-CsVoiceRoute](Get-CsVoiceRoute.md) -{{Manually Enter Get-CsVoiceRoute Description Here}} - ### [Get-CsVoiceRoutingPolicy](Get-CsVoiceRoutingPolicy.md) -{{Manually Enter Get-CsVoiceRoutingPolicy Description Here}} - ### [Get-CsVoiceTestConfiguration](Get-CsVoiceTestConfiguration.md) -{{Manually Enter Get-CsVoiceTestConfiguration Description Here}} - ### [Get-CsWatcherNodeConfiguration](Get-CsWatcherNodeConfiguration.md) -{{Manually Enter Get-CsWatcherNodeConfiguration Description Here}} - ### [Get-CsWebServiceConfiguration](Get-CsWebServiceConfiguration.md) -{{Manually Enter Get-CsWebServiceConfiguration Description Here}} - ### [Get-CsWindowsService](Get-CsWindowsService.md) -{{Manually Enter Get-CsWindowsService Description Here}} - ### [Get-CsXmppAllowedPartner](Get-CsXmppAllowedPartner.md) -{{Manually Enter Get-CsXmppAllowedPartner Description Here}} - ### [Get-CsXmppGatewayConfiguration](Get-CsXmppGatewayConfiguration.md) -{{Manually Enter Get-CsXmppGatewayConfiguration Description Here}} - ### [Grant-CsArchivingPolicy](Grant-CsArchivingPolicy.md) -{{Manually Enter Grant-CsArchivingPolicy Description Here}} - -### [Grant-CsBroadcastMeetingPolicy](Grant-CsBroadcastMeetingPolicy.md) -{{Manually Enter Grant-CsBroadcastMeetingPolicy Description Here}} - -### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) -{{Manually Enter Grant-CsCallingLineIdentity Description Here}} - ### [Grant-CsCallViaWorkPolicy](Grant-CsCallViaWorkPolicy.md) -{{Manually Enter Grant-CsCallViaWorkPolicy Description Here}} - ### [Grant-CsClientPolicy](Grant-CsClientPolicy.md) -{{Manually Enter Grant-CsClientPolicy Description Here}} - ### [Grant-CsClientVersionPolicy](Grant-CsClientVersionPolicy.md) -{{Manually Enter Grant-CsClientVersionPolicy Description Here}} - -### [Grant-CsCloudMeetingPolicy](Grant-CsCloudMeetingPolicy.md) -{{Manually Enter Grant-CsCloudMeetingPolicy Description Here}} - ### [Grant-CsConferencingPolicy](Grant-CsConferencingPolicy.md) -{{Manually Enter Grant-CsConferencingPolicy Description Here}} - -### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) -{{Manually Enter Grant-CsDialoutPolicy Description Here}} - ### [Grant-CsDialPlan](Grant-CsDialPlan.md) -{{Manually Enter Grant-CsDialPlan Description Here}} - ### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) -{{Manually Enter Grant-CsExternalAccessPolicy Description Here}} - -### [Grant-CsExternalUserCommunicationPolicy](Grant-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Grant-CsExternalUserCommunicationPolicy Description Here}} - -### [Grant-CsGraphPolicy](Grant-CsGraphPolicy.md) -{{Manually Enter Grant-CsGraphPolicy Description Here}} - ### [Grant-CsHostedVoicemailPolicy](Grant-CsHostedVoicemailPolicy.md) -{{Manually Enter Grant-CsHostedVoicemailPolicy Description Here}} - ### [Grant-CsIPPhonePolicy](Grant-CsIPPhonePolicy.md) -{{Manually Enter Grant-CsIPPhonePolicy Description Here}} - ### [Grant-CsLocationPolicy](Grant-CsLocationPolicy.md) -{{Manually Enter Grant-CsLocationPolicy Description Here}} - ### [Grant-CsMobilityPolicy](Grant-CsMobilityPolicy.md) -{{Manually Enter Grant-CsMobilityPolicy Description Here}} - -### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) -{{Manually Enter Grant-CsOnlineVoicemailPolicy Description Here}} - ### [Grant-CsOUPermission](Grant-CsOUPermission.md) -{{Manually Enter Grant-CsOUPermission Description Here}} - ### [Grant-CsPersistentChatPolicy](Grant-CsPersistentChatPolicy.md) -{{Manually Enter Grant-CsPersistentChatPolicy Description Here}} - ### [Grant-CsPinPolicy](Grant-CsPinPolicy.md) -{{Manually Enter Grant-CsPinPolicy Description Here}} - ### [Grant-CsPresencePolicy](Grant-CsPresencePolicy.md) -{{Manually Enter Grant-CsPresencePolicy Description Here}} - ### [Grant-CsSetupPermission](Grant-CsSetupPermission.md) -{{Manually Enter Grant-CsSetupPermission Description Here}} - -### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) -{{Manually Enter Grant-CsTeamsCallingPolicy Description Here}} - -### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) -{{Manually Enter Grant-CsTeamsMobilityPolicy Description Here}} - -### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) -{{Manually Enter Grant-CsTeamsEmergencyCallingPolicy Description Here}} - -### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) -{{Manually Enter Grant-CsTeamsEmergencyCallRoutingPolicy Description Here}} - -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) -{{Manually Enter Grant-CsTeamsMeetingPolicy Description Here}} - -### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) -{{Manually Enter Grant-CsTenantDialPlan Description Here}} - +### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) ### [Grant-CsThirdPartyVideoSystemPolicy](Grant-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Grant-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Grant-CsUserServicesPolicy](Grant-CsUserServicesPolicy.md) -{{Manually Enter Grant-CsUserServicesPolicy Description Here}} - ### [Grant-CsVoicePolicy](Grant-CsVoicePolicy.md) -{{Manually Enter Grant-CsVoicePolicy Description Here}} - ### [Grant-CsVoiceRoutingPolicy](Grant-CsVoiceRoutingPolicy.md) -{{Manually Enter Grant-CsVoiceRoutingPolicy Description Here}} - ### [Import-CSAnnouncementFile](Import-CSAnnouncementFile.md) -{{Manually Enter Import-CSAnnouncementFile Description Here}} - ### [Import-CsCertificate](Import-CsCertificate.md) -{{Manually Enter Import-CsCertificate Description Here}} - ### [Import-CsCompanyPhoneNormalizationRules](Import-CsCompanyPhoneNormalizationRules.md) -{{Manually Enter Import-CsCompanyPhoneNormalizationRules Description Here}} - ### [Import-CsConfiguration](Import-CsConfiguration.md) -{{Manually Enter Import-CsConfiguration Description Here}} - ### [Import-CsDeviceUpdate](Import-CsDeviceUpdate.md) -{{Manually Enter Import-CsDeviceUpdate Description Here}} - ### [Import-CsLegacyConferenceDirectory](Import-CsLegacyConferenceDirectory.md) -{{Manually Enter Import-CsLegacyConferenceDirectory Description Here}} - ### [Import-CsLegacyConfiguration](Import-CsLegacyConfiguration.md) -{{Manually Enter Import-CsLegacyConfiguration Description Here}} - ### [Import-CsLisConfiguration](Import-CsLisConfiguration.md) -{{Manually Enter Import-CsLisConfiguration Description Here}} - ### [Import-CsPersistentChatData](Import-CsPersistentChatData.md) -{{Manually Enter Import-CsPersistentChatData Description Here}} - ### [Import-CsRgsAudioFile](Import-CsRgsAudioFile.md) -{{Manually Enter Import-CsRgsAudioFile Description Here}} - ### [Import-CsRgsConfiguration](Import-CsRgsConfiguration.md) -{{Manually Enter Import-CsRgsConfiguration Description Here}} - ### [Import-CsUserData](Import-CsUserData.md) -{{Manually Enter Import-CsUserData Description Here}} - ### [Install-CsAdServerSchema](Install-CsAdServerSchema.md) -{{Manually Enter Install-CsAdServerSchema Description Here}} - ### [Install-CsDatabase](Install-CsDatabase.md) -{{Manually Enter Install-CsDatabase Description Here}} - ### [Install-CsMirrorDatabase](Install-CsMirrorDatabase.md) -{{Manually Enter Install-CsMirrorDatabase Description Here}} - ### [Invoke-CsArchivingDatabasePurge](Invoke-CsArchivingDatabasePurge.md) -{{Manually Enter Invoke-CsArchivingDatabasePurge Description Here}} - ### [Invoke-CsBackupServiceSync](Invoke-CsBackupServiceSync.md) -{{Manually Enter Invoke-CsBackupServiceSync Description Here}} - ### [Invoke-CsCdrDatabasePurge](Invoke-CsCdrDatabasePurge.md) -{{Manually Enter Invoke-CsCdrDatabasePurge Description Here}} - ### [Invoke-CsComputerFailBack](Invoke-CsComputerFailBack.md) -{{Manually Enter Invoke-CsComputerFailBack Description Here}} - ### [Invoke-CsComputerFailOver](Invoke-CsComputerFailOver.md) -{{Manually Enter Invoke-CsComputerFailOver Description Here}} - ### [Invoke-CsDatabaseFailover](Invoke-CsDatabaseFailover.md) -{{Manually Enter Invoke-CsDatabaseFailover Description Here}} - ### [Invoke-CsManagementServerFailover](Invoke-CsManagementServerFailover.md) -{{Manually Enter Invoke-CsManagementServerFailover Description Here}} - ### [Invoke-CsManagementStoreReplication](Invoke-CsManagementStoreReplication.md) -{{Manually Enter Invoke-CsManagementStoreReplication Description Here}} - ### [Invoke-CsPoolFailBack](Invoke-CsPoolFailBack.md) -{{Manually Enter Invoke-CsPoolFailBack Description Here}} - ### [Invoke-CsPoolFailOver](Invoke-CsPoolFailOver.md) -{{Manually Enter Invoke-CsPoolFailOver Description Here}} - ### [Invoke-CsQoEDatabasePurge](Invoke-CsQoEDatabasePurge.md) -{{Manually Enter Invoke-CsQoEDatabasePurge Description Here}} - ### [Invoke-CsRgsStoreReplicateData](Invoke-CsRgsStoreReplicateData.md) -{{Manually Enter Invoke-CsRgsStoreReplicateData Description Here}} - ### [Invoke-CsStorageServiceFlush](Invoke-CsStorageServiceFlush.md) -{{Manually Enter Invoke-CsStorageServiceFlush Description Here}} - ### [Invoke-CsUcsRollback](Invoke-CsUcsRollback.md) -{{Manually Enter Invoke-CsUcsRollback Description Here}} - ### [Lock-CsClientPin](Lock-CsClientPin.md) -{{Manually Enter Lock-CsClientPin Description Here}} - ### [Merge-CsLegacyTopology](Merge-CsLegacyTopology.md) -{{Manually Enter Merge-CsLegacyTopology Description Here}} - ### [Move-CsAnalogDevice](Move-CsAnalogDevice.md) -{{Manually Enter Move-CsAnalogDevice Description Here}} - ### [Move-CsApplicationEndpoint](Move-CsApplicationEndpoint.md) -{{Manually Enter Move-CsApplicationEndpoint Description Here}} - ### [Move-CsCommonAreaPhone](Move-CsCommonAreaPhone.md) -{{Manually Enter Move-CsCommonAreaPhone Description Here}} - ### [Move-CsConferenceDirectory](Move-CsConferenceDirectory.md) -{{Manually Enter Move-CsConferenceDirectory Description Here}} - ### [Move-CsExUmContact](Move-CsExUmContact.md) -{{Manually Enter Move-CsExUmContact Description Here}} - ### [Move-CsLegacyUser](Move-CsLegacyUser.md) -{{Manually Enter Move-CsLegacyUser Description Here}} - ### [Move-CsManagementServer](Move-CsManagementServer.md) -{{Manually Enter Move-CsManagementServer Description Here}} - ### [Move-CsMeetingRoom](Move-CsMeetingRoom.md) -{{Manually Enter Move-CsMeetingRoom Description Here}} - ### [Move-CsRgsConfiguration](Move-CsRgsConfiguration.md) -{{Manually Enter Move-CsRgsConfiguration Description Here}} - ### [Move-CsThirdPartyVideoSystem](Move-CsThirdPartyVideoSystem.md) -{{Manually Enter Move-CsThirdPartyVideoSystem Description Here}} - ### [Move-CsUser](Move-CsUser.md) -{{Manually Enter Move-CsUser Description Here}} - +### [New-CsAdditionalInternalDomain](New-CsAdditionalInternalDomain.md) ### [New-CsAddressBookConfiguration](New-CsAddressBookConfiguration.md) -{{Manually Enter New-CsAddressBookConfiguration Description Here}} - ### [New-CsAddressBookNormalizationConfiguration](New-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter New-CsAddressBookNormalizationConfiguration Description Here}} - ### [New-CsAddressBookNormalizationRule](New-CsAddressBookNormalizationRule.md) -{{Manually Enter New-CsAddressBookNormalizationRule Description Here}} - ### [New-CsAdminRole](New-CsAdminRole.md) -{{Manually Enter New-CsAdminRole Description Here}} - ### [New-CsAllowedDomain](New-CsAllowedDomain.md) -{{Manually Enter New-CsAllowedDomain Description Here}} - ### [New-CsAnalogDevice](New-CsAnalogDevice.md) -{{Manually Enter New-CsAnalogDevice Description Here}} - ### [New-CsAnnouncement](New-CsAnnouncement.md) -{{Manually Enter New-CsAnnouncement Description Here}} - ### [New-CsArchivingConfiguration](New-CsArchivingConfiguration.md) -{{Manually Enter New-CsArchivingConfiguration Description Here}} - ### [New-CsArchivingPolicy](New-CsArchivingPolicy.md) -{{Manually Enter New-CsArchivingPolicy Description Here}} - ### [New-CsAutodiscoverConfiguration](New-CsAutodiscoverConfiguration.md) -{{Manually Enter New-CsAutodiscoverConfiguration Description Here}} - ### [New-CsAVEdgeConfiguration](New-CsAVEdgeConfiguration.md) -{{Manually Enter New-CsAVEdgeConfiguration Description Here}} - ### [New-CsBandwidthPolicyServiceConfiguration](New-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter New-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [New-CsBlockedDomain](New-CsBlockedDomain.md) -{{Manually Enter New-CsBlockedDomain Description Here}} - -### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) -{{Manually Enter New-CsCallingLineIdentity Description Here}} - ### [New-CsCallParkOrbit](New-CsCallParkOrbit.md) -{{Manually Enter New-CsCallParkOrbit Description Here}} - ### [New-CsCallViaWorkPolicy](New-CsCallViaWorkPolicy.md) -{{Manually Enter New-CsCallViaWorkPolicy Description Here}} - ### [New-CsCdrConfiguration](New-CsCdrConfiguration.md) -{{Manually Enter New-CsCdrConfiguration Description Here}} - ### [New-CsClientPolicy](New-CsClientPolicy.md) -{{Manually Enter New-CsClientPolicy Description Here}} - ### [New-CsClientPolicyEntry](New-CsClientPolicyEntry.md) -{{Manually Enter New-CsClientPolicyEntry Description Here}} - ### [New-CsClientVersionConfiguration](New-CsClientVersionConfiguration.md) -{{Manually Enter New-CsClientVersionConfiguration Description Here}} - ### [New-CsClientVersionPolicy](New-CsClientVersionPolicy.md) -{{Manually Enter New-CsClientVersionPolicy Description Here}} - ### [New-CsClientVersionPolicyRule](New-CsClientVersionPolicyRule.md) -{{Manually Enter New-CsClientVersionPolicyRule Description Here}} - +### [New-CsCloudCallDataConnectorConfiguration](New-CsCloudCallDataConnectorConfiguration.md) ### [New-CsClsConfiguration](New-CsClsConfiguration.md) -{{Manually Enter New-CsClsConfiguration Description Here}} - ### [New-CsClsProvider](New-CsClsProvider.md) -{{Manually Enter New-CsClsProvider Description Here}} - ### [New-CsClsRegion](New-CsClsRegion.md) -{{Manually Enter New-CsClsRegion Description Here}} - ### [New-CsClsScenario](New-CsClsScenario.md) -{{Manually Enter New-CsClsScenario Description Here}} - ### [New-CsClsSecurityGroup](New-CsClsSecurityGroup.md) -{{Manually Enter New-CsClsSecurityGroup Description Here}} - ### [New-CsCommonAreaPhone](New-CsCommonAreaPhone.md) -{{Manually Enter New-CsCommonAreaPhone Description Here}} - ### [New-CsConferenceDirectory](New-CsConferenceDirectory.md) -{{Manually Enter New-CsConferenceDirectory Description Here}} - ### [New-CsConferencingConfiguration](New-CsConferencingConfiguration.md) -{{Manually Enter New-CsConferencingConfiguration Description Here}} - ### [New-CsConferencingPolicy](New-CsConferencingPolicy.md) -{{Manually Enter New-CsConferencingPolicy Description Here}} - ### [New-CsCpsConfiguration](New-CsCpsConfiguration.md) -{{Manually Enter New-CsCpsConfiguration Description Here}} - ### [New-CsDeviceUpdateConfiguration](New-CsDeviceUpdateConfiguration.md) -{{Manually Enter New-CsDeviceUpdateConfiguration Description Here}} - ### [New-CsDiagnosticConfiguration](New-CsDiagnosticConfiguration.md) -{{Manually Enter New-CsDiagnosticConfiguration Description Here}} - ### [New-CsDiagnosticHeaderConfiguration](New-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter New-CsDiagnosticHeaderConfiguration Description Here}} - ### [New-CsDiagnosticsFilter](New-CsDiagnosticsFilter.md) -{{Manually Enter New-CsDiagnosticsFilter Description Here}} - ### [New-CsDialInConferencingAccessNumber](New-CsDialInConferencingAccessNumber.md) -{{Manually Enter New-CsDialInConferencingAccessNumber Description Here}} - ### [New-CsDialInConferencingConfiguration](New-CsDialInConferencingConfiguration.md) -{{Manually Enter New-CsDialInConferencingConfiguration Description Here}} - ### [New-CsDialInConferencingDtmfConfiguration](New-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter New-CsDialInConferencingDtmfConfiguration Description Here}} - ### [New-CsDialPlan](New-CsDialPlan.md) -{{Manually Enter New-CsDialPlan Description Here}} - -### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) -{{Manually Enter New-CsEdgeAllowAllKnownDomains Description Here}} - -### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) -{{Manually Enter New-CsEdgeAllowList Description Here}} - -### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) -{{Manually Enter New-CsEdgeDomainPattern Description Here}} - ### [New-CsEmergencyNumber](New-CsEmergencyNumber.md) -{{Manually Enter New-CsEmergencyNumber Description Here}} - ### [New-CsExtendedTest](New-CsExtendedTest.md) -{{Manually Enter New-CsExtendedTest Description Here}} - ### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) -{{Manually Enter New-CsExternalAccessPolicy Description Here}} - -### [New-CsExternalUserCommunicationPolicy](New-CsExternalUserCommunicationPolicy.md) -{{Manually Enter New-CsExternalUserCommunicationPolicy Description Here}} - ### [New-CsExUmContact](New-CsExUmContact.md) -{{Manually Enter New-CsExUmContact Description Here}} - ### [New-CsFileTransferFilterConfiguration](New-CsFileTransferFilterConfiguration.md) -{{Manually Enter New-CsFileTransferFilterConfiguration Description Here}} - ### [New-CsFIPSConfiguration](New-CsFIPSConfiguration.md) -{{Manually Enter New-CsFIPSConfiguration Description Here}} - ### [New-CsGroupPickupUserOrbit](New-CsGroupPickupUserOrbit.md) -{{Manually Enter New-CsGroupPickupUserOrbit Description Here}} - ### [New-CsHealthMonitoringConfiguration](New-CsHealthMonitoringConfiguration.md) -{{Manually Enter New-CsHealthMonitoringConfiguration Description Here}} - ### [New-CsHostedVoicemailPolicy](New-CsHostedVoicemailPolicy.md) -{{Manually Enter New-CsHostedVoicemailPolicy Description Here}} - ### [New-CsHostingProvider](New-CsHostingProvider.md) -{{Manually Enter New-CsHostingProvider Description Here}} - -### [New-CsHuntGroup](New-CsHuntGroup.md) -{{Manually Enter New-CsHuntGroup Description Here}} - -### [New-CsHybridPSTNSite](New-CsHybridPSTNSite.md) -{{Manually Enter New-CsHybridPSTNSite Description Here}} - +### [New-CsHybridApplicationEndpoint](New-CsHybridApplicationEndpoint.md) ### [New-CsImConfiguration](New-CsImConfiguration.md) -{{Manually Enter New-CsImConfiguration Description Here}} - ### [New-CsImFilterConfiguration](New-CsImFilterConfiguration.md) -{{Manually Enter New-CsImFilterConfiguration Description Here}} - ### [New-CsImTranslationConfiguration](New-CsImTranslationConfiguration.md) -{{Manually Enter New-CsImTranslationConfiguration Description Here}} - ### [New-CsIssuedCertId](New-CsIssuedCertId.md) -{{Manually Enter New-CsIssuedCertId Description Here}} - ### [New-CsKerberosAccount](New-CsKerberosAccount.md) -{{Manually Enter New-CsKerberosAccount Description Here}} - ### [New-CsKerberosAccountAssignment](New-CsKerberosAccountAssignment.md) -{{Manually Enter New-CsKerberosAccountAssignment Description Here}} - ### [New-CsLocationPolicy](New-CsLocationPolicy.md) -{{Manually Enter New-CsLocationPolicy Description Here}} - ### [New-CsMcxConfiguration](New-CsMcxConfiguration.md) -{{Manually Enter New-CsMcxConfiguration Description Here}} - ### [New-CsMediaConfiguration](New-CsMediaConfiguration.md) -{{Manually Enter New-CsMediaConfiguration Description Here}} - ### [New-CsMeetingConfiguration](New-CsMeetingConfiguration.md) -{{Manually Enter New-CsMeetingConfiguration Description Here}} - ### [New-CsMobilityPolicy](New-CsMobilityPolicy.md) -{{Manually Enter New-CsMobilityPolicy Description Here}} - ### [New-CsNetworkBandwidthPolicyProfile](New-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter New-CsNetworkBandwidthPolicyProfile Description Here}} - ### [New-CsNetworkBWAlternatePath](New-CsNetworkBWAlternatePath.md) -{{Manually Enter New-CsNetworkBWAlternatePath Description Here}} - ### [New-CsNetworkBWPolicy](New-CsNetworkBWPolicy.md) -{{Manually Enter New-CsNetworkBWPolicy Description Here}} - ### [New-CsNetworkInterRegionRoute](New-CsNetworkInterRegionRoute.md) -{{Manually Enter New-CsNetworkInterRegionRoute Description Here}} - ### [New-CsNetworkInterSitePolicy](New-CsNetworkInterSitePolicy.md) -{{Manually Enter New-CsNetworkInterSitePolicy Description Here}} - ### [New-CsNetworkMediaBypassConfiguration](New-CsNetworkMediaBypassConfiguration.md) -{{Manually Enter New-CsNetworkMediaBypassConfiguration Description Here}} - ### [New-CsNetworkRegion](New-CsNetworkRegion.md) -{{Manually Enter New-CsNetworkRegion Description Here}} - ### [New-CsNetworkRegionLink](New-CsNetworkRegionLink.md) -{{Manually Enter New-CsNetworkRegionLink Description Here}} - ### [New-CsNetworkSite](New-CsNetworkSite.md) -{{Manually Enter New-CsNetworkSite Description Here}} - ### [New-CsNetworkSubnet](New-CsNetworkSubnet.md) -{{Manually Enter New-CsNetworkSubnet Description Here}} - ### [New-CsOAuthServer](New-CsOAuthServer.md) -{{Manually Enter New-CsOAuthServer Description Here}} - -### [New-CsOnlineApplicationEndpoint](New-CsOnlineApplicationEndpoint.md) -{{Manually Enter New-CsOnlineApplicationEndpoint Description Here}} - -### [New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) -{{Manually Enter New-CsOnlineAudioFile Description Here}} - ### [New-CsOnlineBulkAssignmentInput](New-CsOnlineBulkAssignmentInput.md) -{{Manually Enter New-CsOnlineBulkAssignmentInput Description Here}} - -### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) -{{Manually Enter New-CsOnlineDateTimeRange Description Here}} - -### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) -{{Manually Enter New-CsOnlineLisCivicAddress Description Here}} - -### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) -{{Manually Enter New-CsOnlineLisLocation Description Here}} - ### [New-CsOnlineNumberPortInOrder](New-CsOnlineNumberPortInOrder.md) -{{Manually Enter New-CsOnlineNumberPortInOrder Description Here}} - -### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) -{{Manually Enter New-CsOnlinePSTNGateway Description Here}} - -### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) -{{Manually Enter New-CsOnlineSchedule Description Here}} - -### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) -{{Manually Enter New-CsOnlineTimeRange Description Here}} - -### [New-CsOrganizationalAutoAttendant](New-CsOrganizationalAutoAttendant.md) -{{Manually Enter New-CsOrganizationalAutoAttendant Description Here}} - -### [New-CsOrganizationalAutoAttendantCallableEntity](New-CsOrganizationalAutoAttendantCallableEntity.md) -{{Manually Enter New-CsOrganizationalAutoAttendantCallableEntity Description Here}} - -### [New-CsOrganizationalAutoAttendantCallFlow](New-CsOrganizationalAutoAttendantCallFlow.md) -{{Manually Enter New-CsOrganizationalAutoAttendantCallFlow Description Here}} - -### [New-CsOrganizationalAutoAttendantCallHandlingAssociation](New-CsOrganizationalAutoAttendantCallHandlingAssociation.md) -{{Manually Enter New-CsOrganizationalAutoAttendantCallHandlingAssociation Description Here}} - -### [New-CsOrganizationalAutoAttendantDialScope](New-CsOrganizationalAutoAttendantDialScope.md) -{{Manually Enter New-CsOrganizationalAutoAttendantDialScope Description Here}} - -### [New-CsOrganizationalAutoAttendantMenu](New-CsOrganizationalAutoAttendantMenu.md) -{{Manually Enter New-CsOrganizationalAutoAttendantMenu Description Here}} - -### [New-CsOrganizationalAutoAttendantMenuOption](New-CsOrganizationalAutoAttendantMenuOption.md) -{{Manually Enter New-CsOrganizationalAutoAttendantMenuOption Description Here}} - -### [New-CsOrganizationalAutoAttendantPrompt](New-CsOrganizationalAutoAttendantPrompt.md) -{{Manually Enter New-CsOrganizationalAutoAttendantPrompt Description Here}} - +### [New-CsOnlineSession](New-CsOnlineSession.md) ### [New-CsOutboundCallingNumberTranslationRule](New-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter New-CsOutboundCallingNumberTranslationRule Description Here}} - ### [New-CsOutboundTranslationRule](New-CsOutboundTranslationRule.md) -{{Manually Enter New-CsOutboundTranslationRule Description Here}} - ### [New-CsPartnerApplication](New-CsPartnerApplication.md) -{{Manually Enter New-CsPartnerApplication Description Here}} - ### [New-CsPersistentChatAddin](New-CsPersistentChatAddin.md) -{{Manually Enter New-CsPersistentChatAddin Description Here}} - ### [New-CsPersistentChatCategory](New-CsPersistentChatCategory.md) -{{Manually Enter New-CsPersistentChatCategory Description Here}} - ### [New-CsPersistentChatComplianceConfiguration](New-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter New-CsPersistentChatComplianceConfiguration Description Here}} - ### [New-CsPersistentChatConfiguration](New-CsPersistentChatConfiguration.md) -{{Manually Enter New-CsPersistentChatConfiguration Description Here}} - ### [New-CsPersistentChatEndpoint](New-CsPersistentChatEndpoint.md) -{{Manually Enter New-CsPersistentChatEndpoint Description Here}} - ### [New-CsPersistentChatPolicy](New-CsPersistentChatPolicy.md) -{{Manually Enter New-CsPersistentChatPolicy Description Here}} - ### [New-CsPersistentChatRoom](New-CsPersistentChatRoom.md) -{{Manually Enter New-CsPersistentChatRoom Description Here}} - ### [New-CsPinPolicy](New-CsPinPolicy.md) -{{Manually Enter New-CsPinPolicy Description Here}} - +### [New-CsPlatformServiceSettings](New-CsPlatformServiceSettings.md) ### [New-CsPresencePolicy](New-CsPresencePolicy.md) -{{Manually Enter New-CsPresencePolicy Description Here}} - ### [New-CsPresenceProvider](New-CsPresenceProvider.md) -{{Manually Enter New-CsPresenceProvider Description Here}} - ### [New-CsPrivacyConfiguration](New-CsPrivacyConfiguration.md) -{{Manually Enter New-CsPrivacyConfiguration Description Here}} - ### [New-CsProxyConfiguration](New-CsProxyConfiguration.md) -{{Manually Enter New-CsProxyConfiguration Description Here}} - ### [New-CsPublicProvider](New-CsPublicProvider.md) -{{Manually Enter New-CsPublicProvider Description Here}} - ### [New-CsPushNotificationConfiguration](New-CsPushNotificationConfiguration.md) -{{Manually Enter New-CsPushNotificationConfiguration Description Here}} - ### [New-CsQoEConfiguration](New-CsQoEConfiguration.md) -{{Manually Enter New-CsQoEConfiguration Description Here}} - ### [New-CsRegistrarConfiguration](New-CsRegistrarConfiguration.md) -{{Manually Enter New-CsRegistrarConfiguration Description Here}} - ### [New-CsReportingConfiguration](New-CsReportingConfiguration.md) -{{Manually Enter New-CsReportingConfiguration Description Here}} - ### [New-CsRgsAgentGroup](New-CsRgsAgentGroup.md) -{{Manually Enter New-CsRgsAgentGroup Description Here}} - ### [New-CsRgsAnswer](New-CsRgsAnswer.md) -{{Manually Enter New-CsRgsAnswer Description Here}} - ### [New-CsRgsCallAction](New-CsRgsCallAction.md) -{{Manually Enter New-CsRgsCallAction Description Here}} - ### [New-CsRgsHoliday](New-CsRgsHoliday.md) -{{Manually Enter New-CsRgsHoliday Description Here}} - ### [New-CsRgsHolidaySet](New-CsRgsHolidaySet.md) -{{Manually Enter New-CsRgsHolidaySet Description Here}} - ### [New-CsRgsHoursOfBusiness](New-CsRgsHoursOfBusiness.md) -{{Manually Enter New-CsRgsHoursOfBusiness Description Here}} - ### [New-CsRgsPrompt](New-CsRgsPrompt.md) -{{Manually Enter New-CsRgsPrompt Description Here}} - ### [New-CsRgsQuestion](New-CsRgsQuestion.md) -{{Manually Enter New-CsRgsQuestion Description Here}} - ### [New-CsRgsQueue](New-CsRgsQueue.md) -{{Manually Enter New-CsRgsQueue Description Here}} - ### [New-CsRgsTimeRange](New-CsRgsTimeRange.md) -{{Manually Enter New-CsRgsTimeRange Description Here}} - ### [New-CsRgsWorkflow](New-CsRgsWorkflow.md) -{{Manually Enter New-CsRgsWorkflow Description Here}} - ### [New-CsRoutingConfiguration](New-CsRoutingConfiguration.md) -{{Manually Enter New-CsRoutingConfiguration Description Here}} - ### [New-CsServerApplication](New-CsServerApplication.md) -{{Manually Enter New-CsServerApplication Description Here}} - ### [New-CsSimpleUrl](New-CsSimpleUrl.md) -{{Manually Enter New-CsSimpleUrl Description Here}} - ### [New-CsSimpleUrlConfiguration](New-CsSimpleUrlConfiguration.md) -{{Manually Enter New-CsSimpleUrlConfiguration Description Here}} - ### [New-CsSimpleUrlEntry](New-CsSimpleUrlEntry.md) -{{Manually Enter New-CsSimpleUrlEntry Description Here}} - ### [New-CsSipDomain](New-CsSipDomain.md) -{{Manually Enter New-CsSipDomain Description Here}} - ### [New-CsSipProxyCustom](New-CsSipProxyCustom.md) -{{Manually Enter New-CsSipProxyCustom Description Here}} - ### [New-CsSipProxyRealm](New-CsSipProxyRealm.md) -{{Manually Enter New-CsSipProxyRealm Description Here}} - ### [New-CsSipProxyTCP](New-CsSipProxyTCP.md) -{{Manually Enter New-CsSipProxyTCP Description Here}} - ### [New-CsSipProxyTLS](New-CsSipProxyTLS.md) -{{Manually Enter New-CsSipProxyTLS Description Here}} - ### [New-CsSipProxyTransport](New-CsSipProxyTransport.md) -{{Manually Enter New-CsSipProxyTransport Description Here}} - ### [New-CsSipProxyUseDefault](New-CsSipProxyUseDefault.md) -{{Manually Enter New-CsSipProxyUseDefault Description Here}} - ### [New-CsSipProxyUseDefaultCert](New-CsSipProxyUseDefaultCert.md) -{{Manually Enter New-CsSipProxyUseDefaultCert Description Here}} - ### [New-CsSipResponseCodeTranslationRule](New-CsSipResponseCodeTranslationRule.md) -{{Manually Enter New-CsSipResponseCodeTranslationRule Description Here}} - ### [New-CsStaticRoute](New-CsStaticRoute.md) -{{Manually Enter New-CsStaticRoute Description Here}} - ### [New-CsStaticRoutingConfiguration](New-CsStaticRoutingConfiguration.md) -{{Manually Enter New-CsStaticRoutingConfiguration Description Here}} - ### [New-CsStorageServiceConfiguration](New-CsStorageServiceConfiguration.md) -{{Manually Enter New-CsStorageServiceConfiguration Description Here}} - -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) -{{Manually Enter New-CsTeamsMeetingPolicy Description Here}} - +### [New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) ### [New-CsTelemetryConfiguration](New-CsTelemetryConfiguration.md) -{{Manually Enter New-CsTelemetryConfiguration Description Here}} - -### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) -{{Manually Enter New-CsTenantDialPlan Description Here}} - -### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) -{{Manually Enter New-CsTenantNetworkRegion Description Here}} - -### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) -{{Manually Enter New-CsTenantNetworkSite Description Here}} - -### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) -{{Manually Enter New-CsTenantNetworkSubnet Description Here}} - -### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) -{{Manually Enter New-CsTenantTrustedIPAddress Description Here}} - -### [New-CsTenantUpdateTimeWindow](New-CsTenantUpdateTimeWindow.md) -{{Manually Enter New-CsTenantUpdateTimeWindow Description Here}} - ### [New-CsTestDevice](New-CsTestDevice.md) -{{Manually Enter New-CsTestDevice Description Here}} - ### [New-CsThirdPartyVideoSystem](New-CsThirdPartyVideoSystem.md) -{{Manually Enter New-CsThirdPartyVideoSystem Description Here}} - ### [New-CsThirdPartyVideoSystemPolicy](New-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter New-CsThirdPartyVideoSystemPolicy Description Here}} - ### [New-CsTrunkConfiguration](New-CsTrunkConfiguration.md) -{{Manually Enter New-CsTrunkConfiguration Description Here}} - ### [New-CsTrustedApplication](New-CsTrustedApplication.md) -{{Manually Enter New-CsTrustedApplication Description Here}} - ### [New-CsTrustedApplicationComputer](New-CsTrustedApplicationComputer.md) -{{Manually Enter New-CsTrustedApplicationComputer Description Here}} - ### [New-CsTrustedApplicationEndpoint](New-CsTrustedApplicationEndpoint.md) -{{Manually Enter New-CsTrustedApplicationEndpoint Description Here}} - ### [New-CsTrustedApplicationPool](New-CsTrustedApplicationPool.md) -{{Manually Enter New-CsTrustedApplicationPool Description Here}} - ### [New-CsUCPhoneConfiguration](New-CsUCPhoneConfiguration.md) -{{Manually Enter New-CsUCPhoneConfiguration Description Here}} - ### [New-CsUnassignedNumber](New-CsUnassignedNumber.md) -{{Manually Enter New-CsUnassignedNumber Description Here}} - ### [New-CsUserReplicatorConfiguration](New-CsUserReplicatorConfiguration.md) -{{Manually Enter New-CsUserReplicatorConfiguration Description Here}} - ### [New-CsUserServicesConfiguration](New-CsUserServicesConfiguration.md) -{{Manually Enter New-CsUserServicesConfiguration Description Here}} - ### [New-CsUserServicesPolicy](New-CsUserServicesPolicy.md) -{{Manually Enter New-CsUserServicesPolicy Description Here}} - ### [New-CsVideoInteropServerConfiguration](New-CsVideoInteropServerConfiguration.md) -{{Manually Enter New-CsVideoInteropServerConfiguration Description Here}} - ### [New-CsVideoInteropServerSyntheticTransactionConfiguration](New-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter New-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [New-CsVideoTrunkConfiguration](New-CsVideoTrunkConfiguration.md) -{{Manually Enter New-CsVideoTrunkConfiguration Description Here}} - ### [New-CsVoicemailReroutingConfiguration](New-CsVoicemailReroutingConfiguration.md) -{{Manually Enter New-CsVoicemailReroutingConfiguration Description Here}} - ### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) -{{Manually Enter New-CsVoiceNormalizationRule Description Here}} - ### [New-CsVoicePolicy](New-CsVoicePolicy.md) -{{Manually Enter New-CsVoicePolicy Description Here}} - ### [New-CsVoiceRegex](New-CsVoiceRegex.md) -{{Manually Enter New-CsVoiceRegex Description Here}} - ### [New-CsVoiceRoute](New-CsVoiceRoute.md) -{{Manually Enter New-CsVoiceRoute Description Here}} - ### [New-CsVoiceRoutingPolicy](New-CsVoiceRoutingPolicy.md) -{{Manually Enter New-CsVoiceRoutingPolicy Description Here}} - ### [New-CsVoiceTestConfiguration](New-CsVoiceTestConfiguration.md) -{{Manually Enter New-CsVoiceTestConfiguration Description Here}} - ### [New-CsWatcherNodeConfiguration](New-CsWatcherNodeConfiguration.md) -{{Manually Enter New-CsWatcherNodeConfiguration Description Here}} - ### [New-CsWebLink](New-CsWebLink.md) -{{Manually Enter New-CsWebLink Description Here}} - ### [New-CsWebOrigin](New-CsWebOrigin.md) -{{Manually Enter New-CsWebOrigin Description Here}} - ### [New-CsWebServiceConfiguration](New-CsWebServiceConfiguration.md) -{{Manually Enter New-CsWebServiceConfiguration Description Here}} - ### [New-CsWebTrustedCACertificate](New-CsWebTrustedCACertificate.md) -{{Manually Enter New-CsWebTrustedCACertificate Description Here}} - ### [New-CsXmppAllowedPartner](New-CsXmppAllowedPartner.md) -{{Manually Enter New-CsXmppAllowedPartner Description Here}} - ### [Publish-CsLisConfiguration](Publish-CsLisConfiguration.md) -{{Manually Enter Publish-CsLisConfiguration Description Here}} - ### [Publish-CsTopology](Publish-CsTopology.md) -{{Manually Enter Publish-CsTopology Description Here}} - -### [Register-CsHybridPSTNAppliance](Register-CsHybridPSTNAppliance.md) -{{Manually Enter Register-CsHybridPSTNAppliance Description Here}} - -### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Register-CsOnlineDialInConferencingServiceNumber Description Here}} - +### [Remove-CsAdditionalInternalDomain](Remove-CsAdditionalInternalDomain.md) ### [Remove-CsAddressBookConfiguration](Remove-CsAddressBookConfiguration.md) -{{Manually Enter Remove-CsAddressBookConfiguration Description Here}} - ### [Remove-CsAddressBookNormalizationConfiguration](Remove-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter Remove-CsAddressBookNormalizationConfiguration Description Here}} - ### [Remove-CsAddressBookNormalizationRule](Remove-CsAddressBookNormalizationRule.md) -{{Manually Enter Remove-CsAddressBookNormalizationRule Description Here}} - ### [Remove-CsAdminRole](Remove-CsAdminRole.md) -{{Manually Enter Remove-CsAdminRole Description Here}} - ### [Remove-CsAllowedDomain](Remove-CsAllowedDomain.md) -{{Manually Enter Remove-CsAllowedDomain Description Here}} - ### [Remove-CsAnalogDevice](Remove-CsAnalogDevice.md) -{{Manually Enter Remove-CsAnalogDevice Description Here}} - ### [Remove-CsAnnouncement](Remove-CsAnnouncement.md) -{{Manually Enter Remove-CsAnnouncement Description Here}} - ### [Remove-CsArchivingConfiguration](Remove-CsArchivingConfiguration.md) -{{Manually Enter Remove-CsArchivingConfiguration Description Here}} - ### [Remove-CsArchivingPolicy](Remove-CsArchivingPolicy.md) -{{Manually Enter Remove-CsArchivingPolicy Description Here}} - ### [Remove-CsAutodiscoverConfiguration](Remove-CsAutodiscoverConfiguration.md) -{{Manually Enter Remove-CsAutodiscoverConfiguration Description Here}} - ### [Remove-CsAVEdgeConfiguration](Remove-CsAVEdgeConfiguration.md) -{{Manually Enter Remove-CsAVEdgeConfiguration Description Here}} - ### [Remove-CsBackupServiceConfiguration](Remove-CsBackupServiceConfiguration.md) -{{Manually Enter Remove-CsBackupServiceConfiguration Description Here}} - ### [Remove-CsBandwidthPolicyServiceConfiguration](Remove-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter Remove-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [Remove-CsBlockedDomain](Remove-CsBlockedDomain.md) -{{Manually Enter Remove-CsBlockedDomain Description Here}} - ### [Remove-CsBusyOptions](Remove-CsBusyOptions.md) -{{Manually Enter Remove-CsBusyOptions Description Here}} - -### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) -{{Manually Enter Remove-CsCallingLineIdentity Description Here}} - ### [Remove-CsCallParkOrbit](Remove-CsCallParkOrbit.md) -{{Manually Enter Remove-CsCallParkOrbit Description Here}} - ### [Remove-CsCallViaWorkPolicy](Remove-CsCallViaWorkPolicy.md) -{{Manually Enter Remove-CsCallViaWorkPolicy Description Here}} - ### [Remove-CsCdrConfiguration](Remove-CsCdrConfiguration.md) -{{Manually Enter Remove-CsCdrConfiguration Description Here}} - ### [Remove-CsCertificate](Remove-CsCertificate.md) -{{Manually Enter Remove-CsCertificate Description Here}} - ### [Remove-CsClientPolicy](Remove-CsClientPolicy.md) -{{Manually Enter Remove-CsClientPolicy Description Here}} - ### [Remove-CsClientVersionConfiguration](Remove-CsClientVersionConfiguration.md) -{{Manually Enter Remove-CsClientVersionConfiguration Description Here}} - ### [Remove-CsClientVersionPolicy](Remove-CsClientVersionPolicy.md) -{{Manually Enter Remove-CsClientVersionPolicy Description Here}} - ### [Remove-CsClientVersionPolicyRule](Remove-CsClientVersionPolicyRule.md) -{{Manually Enter Remove-CsClientVersionPolicyRule Description Here}} - ### [Remove-CsClsConfiguration](Remove-CsClsConfiguration.md) -{{Manually Enter Remove-CsClsConfiguration Description Here}} - ### [Remove-CsClsRegion](Remove-CsClsRegion.md) -{{Manually Enter Remove-CsClsRegion Description Here}} - ### [Remove-CsClsScenario](Remove-CsClsScenario.md) -{{Manually Enter Remove-CsClsScenario Description Here}} - ### [Remove-CsClsSecurityGroup](Remove-CsClsSecurityGroup.md) -{{Manually Enter Remove-CsClsSecurityGroup Description Here}} - ### [Remove-CsCommonAreaPhone](Remove-CsCommonAreaPhone.md) -{{Manually Enter Remove-CsCommonAreaPhone Description Here}} - ### [Remove-CsConferenceDirectory](Remove-CsConferenceDirectory.md) -{{Manually Enter Remove-CsConferenceDirectory Description Here}} - ### [Remove-CsConferenceDisclaimer](Remove-CsConferenceDisclaimer.md) -{{Manually Enter Remove-CsConferenceDisclaimer Description Here}} - ### [Remove-CsConferencingConfiguration](Remove-CsConferencingConfiguration.md) -{{Manually Enter Remove-CsConferencingConfiguration Description Here}} - ### [Remove-CsConferencingPolicy](Remove-CsConferencingPolicy.md) -{{Manually Enter Remove-CsConferencingPolicy Description Here}} - ### [Remove-CsConfigurationStoreLocation](Remove-CsConfigurationStoreLocation.md) -{{Manually Enter Remove-CsConfigurationStoreLocation Description Here}} - ### [Remove-CsConversationHistoryConfiguration](Remove-CsConversationHistoryConfiguration.md) -{{Manually Enter Remove-CsConversationHistoryConfiguration Description Here}} - ### [Remove-CsCpsConfiguration](Remove-CsCpsConfiguration.md) -{{Manually Enter Remove-CsCpsConfiguration Description Here}} - ### [Remove-CsDeviceUpdateConfiguration](Remove-CsDeviceUpdateConfiguration.md) -{{Manually Enter Remove-CsDeviceUpdateConfiguration Description Here}} - ### [Remove-CsDeviceUpdateRule](Remove-CsDeviceUpdateRule.md) -{{Manually Enter Remove-CsDeviceUpdateRule Description Here}} - ### [Remove-CsDiagnosticConfiguration](Remove-CsDiagnosticConfiguration.md) -{{Manually Enter Remove-CsDiagnosticConfiguration Description Here}} - ### [Remove-CsDiagnosticHeaderConfiguration](Remove-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter Remove-CsDiagnosticHeaderConfiguration Description Here}} - ### [Remove-CsDialInConferencingAccessNumber](Remove-CsDialInConferencingAccessNumber.md) -{{Manually Enter Remove-CsDialInConferencingAccessNumber Description Here}} - ### [Remove-CsDialInConferencingConfiguration](Remove-CsDialInConferencingConfiguration.md) -{{Manually Enter Remove-CsDialInConferencingConfiguration Description Here}} - ### [Remove-CsDialInConferencingDtmfConfiguration](Remove-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter Remove-CsDialInConferencingDtmfConfiguration Description Here}} - ### [Remove-CsDialPlan](Remove-CsDialPlan.md) -{{Manually Enter Remove-CsDialPlan Description Here}} - ### [Remove-CsEnhancedEmergencyServiceDisclaimer](Remove-CsEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Remove-CsEnhancedEmergencyServiceDisclaimer Description Here}} - ### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) -{{Manually Enter Remove-CsExternalAccessPolicy Description Here}} - -### [Remove-CsExternalUserCommunicationPolicy](Remove-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Remove-CsExternalUserCommunicationPolicy Description Here}} - ### [Remove-CsExUmContact](Remove-CsExUmContact.md) -{{Manually Enter Remove-CsExUmContact Description Here}} - ### [Remove-CsFileTransferFilterConfiguration](Remove-CsFileTransferFilterConfiguration.md) -{{Manually Enter Remove-CsFileTransferFilterConfiguration Description Here}} - ### [Remove-CsFIPSConfiguration](Remove-CsFIPSConfiguration.md) -{{Manually Enter Remove-CsFIPSConfiguration Description Here}} - ### [Remove-CsGroupPickupUserOrbit](Remove-CsGroupPickupUserOrbit.md) -{{Manually Enter Remove-CsGroupPickupUserOrbit Description Here}} - ### [Remove-CsHealthMonitoringConfiguration](Remove-CsHealthMonitoringConfiguration.md) -{{Manually Enter Remove-CsHealthMonitoringConfiguration Description Here}} - ### [Remove-CsHostedVoicemailPolicy](Remove-CsHostedVoicemailPolicy.md) -{{Manually Enter Remove-CsHostedVoicemailPolicy Description Here}} - ### [Remove-CsHostingProvider](Remove-CsHostingProvider.md) -{{Manually Enter Remove-CsHostingProvider Description Here}} - -### [Remove-CsHuntGroup](Remove-CsHuntGroup.md) -{{Manually Enter Remove-CsHuntGroup Description Here}} - -### [Remove-CsHybridPSTNSite](Remove-CsHybridPSTNSite.md) -{{Manually Enter Remove-CsHybridPSTNSite Description Here}} - +### [Remove-CsHybridApplicationEndpoint](Remove-CsHybridApplicationEndpoint.md) ### [Remove-CsImConfiguration](Remove-CsImConfiguration.md) -{{Manually Enter Remove-CsImConfiguration Description Here}} - ### [Remove-CsImFilterConfiguration](Remove-CsImFilterConfiguration.md) -{{Manually Enter Remove-CsImFilterConfiguration Description Here}} - ### [Remove-CsImTranslationConfiguration](Remove-CsImTranslationConfiguration.md) -{{Manually Enter Remove-CsImTranslationConfiguration Description Here}} - ### [Remove-CsKerberosAccountAssignment](Remove-CsKerberosAccountAssignment.md) -{{Manually Enter Remove-CsKerberosAccountAssignment Description Here}} - ### [Remove-CsLisLocation](Remove-CsLisLocation.md) -{{Manually Enter Remove-CsLisLocation Description Here}} - ### [Remove-CsLisPort](Remove-CsLisPort.md) -{{Manually Enter Remove-CsLisPort Description Here}} - ### [Remove-CsLisServiceProvider](Remove-CsLisServiceProvider.md) -{{Manually Enter Remove-CsLisServiceProvider Description Here}} - ### [Remove-CsLisSubnet](Remove-CsLisSubnet.md) -{{Manually Enter Remove-CsLisSubnet Description Here}} - ### [Remove-CsLisSwitch](Remove-CsLisSwitch.md) -{{Manually Enter Remove-CsLisSwitch Description Here}} - ### [Remove-CsLisWirelessAccessPoint](Remove-CsLisWirelessAccessPoint.md) -{{Manually Enter Remove-CsLisWirelessAccessPoint Description Here}} - ### [Remove-CsLocationPolicy](Remove-CsLocationPolicy.md) -{{Manually Enter Remove-CsLocationPolicy Description Here}} - ### [Remove-CsManagementConnection](Remove-CsManagementConnection.md) -{{Manually Enter Remove-CsManagementConnection Description Here}} - ### [Remove-CsMcxConfiguration](Remove-CsMcxConfiguration.md) -{{Manually Enter Remove-CsMcxConfiguration Description Here}} - ### [Remove-CsMediaConfiguration](Remove-CsMediaConfiguration.md) -{{Manually Enter Remove-CsMediaConfiguration Description Here}} - ### [Remove-CsMeetingConfiguration](Remove-CsMeetingConfiguration.md) -{{Manually Enter Remove-CsMeetingConfiguration Description Here}} - ### [Remove-CsMobilityPolicy](Remove-CsMobilityPolicy.md) -{{Manually Enter Remove-CsMobilityPolicy Description Here}} - ### [Remove-CsNetworkBandwidthPolicyProfile](Remove-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter Remove-CsNetworkBandwidthPolicyProfile Description Here}} - ### [Remove-CsNetworkConfiguration](Remove-CsNetworkConfiguration.md) -{{Manually Enter Remove-CsNetworkConfiguration Description Here}} - ### [Remove-CsNetworkInterRegionRoute](Remove-CsNetworkInterRegionRoute.md) -{{Manually Enter Remove-CsNetworkInterRegionRoute Description Here}} - ### [Remove-CsNetworkInterSitePolicy](Remove-CsNetworkInterSitePolicy.md) -{{Manually Enter Remove-CsNetworkInterSitePolicy Description Here}} - ### [Remove-CsNetworkRegion](Remove-CsNetworkRegion.md) -{{Manually Enter Remove-CsNetworkRegion Description Here}} - ### [Remove-CsNetworkRegionLink](Remove-CsNetworkRegionLink.md) -{{Manually Enter Remove-CsNetworkRegionLink Description Here}} - ### [Remove-CsNetworkSite](Remove-CsNetworkSite.md) -{{Manually Enter Remove-CsNetworkSite Description Here}} - ### [Remove-CsNetworkSubnet](Remove-CsNetworkSubnet.md) -{{Manually Enter Remove-CsNetworkSubnet Description Here}} - ### [Remove-CsOAuthServer](Remove-CsOAuthServer.md) -{{Manually Enter Remove-CsOAuthServer Description Here}} - -### [Remove-CsOnlineApplicationEndpoint](Remove-CsOnlineApplicationEndpoint.md) -{{Manually Enter Remove-CsOnlineApplicationEndpoint Description Here}} - -### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) -{{Manually Enter Remove-CsOnlineDialInConferencingTenantSettings Description Here}} - -### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) -{{Manually Enter Remove-CsOnlineLisCivicAddress Description Here}} - -### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) -{{Manually Enter Remove-CsOnlineLisLocation Description Here}} - ### [Remove-CsOnlineNumberPortInOrder](Remove-CsOnlineNumberPortInOrder.md) -{{Manually Enter Remove-CsOnlineNumberPortInOrder Description Here}} - -### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) -{{Manually Enter Remove-CsOnlinePSTNGateway Description Here}} - -### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) -{{Manually Enter Remove-CsOnlineTelephoneNumber Description Here}} - -### [Remove-CsOrganizationalAutoAttendant](Remove-CsOrganizationalAutoAttendant.md) -{{Manually Enter Remove-CsOrganizationalAutoAttendant Description Here}} - ### [Remove-CsOutboundCallingNumberTranslationRule](Remove-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter Remove-CsOutboundCallingNumberTranslationRule Description Here}} - ### [Remove-CsOutboundTranslationRule](Remove-CsOutboundTranslationRule.md) -{{Manually Enter Remove-CsOutboundTranslationRule Description Here}} - ### [Remove-CsPartnerApplication](Remove-CsPartnerApplication.md) -{{Manually Enter Remove-CsPartnerApplication Description Here}} - ### [Remove-CsPersistentChatAddin](Remove-CsPersistentChatAddin.md) -{{Manually Enter Remove-CsPersistentChatAddin Description Here}} - ### [Remove-CsPersistentChatCategory](Remove-CsPersistentChatCategory.md) -{{Manually Enter Remove-CsPersistentChatCategory Description Here}} - ### [Remove-CsPersistentChatComplianceConfiguration](Remove-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter Remove-CsPersistentChatComplianceConfiguration Description Here}} - ### [Remove-CsPersistentChatConfiguration](Remove-CsPersistentChatConfiguration.md) -{{Manually Enter Remove-CsPersistentChatConfiguration Description Here}} - ### [Remove-CsPersistentChatEndpoint](Remove-CsPersistentChatEndpoint.md) -{{Manually Enter Remove-CsPersistentChatEndpoint Description Here}} - ### [Remove-CsPersistentChatMessage](Remove-CsPersistentChatMessage.md) -{{Manually Enter Remove-CsPersistentChatMessage Description Here}} - ### [Remove-CsPersistentChatPolicy](Remove-CsPersistentChatPolicy.md) -{{Manually Enter Remove-CsPersistentChatPolicy Description Here}} - ### [Remove-CsPersistentChatRoom](Remove-CsPersistentChatRoom.md) -{{Manually Enter Remove-CsPersistentChatRoom Description Here}} - ### [Remove-CsPinPolicy](Remove-CsPinPolicy.md) -{{Manually Enter Remove-CsPinPolicy Description Here}} - +### [Remove-CsPlatformServiceSettings](Remove-CsPlatformServiceSettings.md) ### [Remove-CsPresencePolicy](Remove-CsPresencePolicy.md) -{{Manually Enter Remove-CsPresencePolicy Description Here}} - ### [Remove-CsPresenceProvider](Remove-CsPresenceProvider.md) -{{Manually Enter Remove-CsPresenceProvider Description Here}} - ### [Remove-CsPrivacyConfiguration](Remove-CsPrivacyConfiguration.md) -{{Manually Enter Remove-CsPrivacyConfiguration Description Here}} - ### [Remove-CsProxyConfiguration](Remove-CsProxyConfiguration.md) -{{Manually Enter Remove-CsProxyConfiguration Description Here}} - ### [Remove-CsPublicProvider](Remove-CsPublicProvider.md) -{{Manually Enter Remove-CsPublicProvider Description Here}} - ### [Remove-CsPushNotificationConfiguration](Remove-CsPushNotificationConfiguration.md) -{{Manually Enter Remove-CsPushNotificationConfiguration Description Here}} - ### [Remove-CsQoEConfiguration](Remove-CsQoEConfiguration.md) -{{Manually Enter Remove-CsQoEConfiguration Description Here}} - ### [Remove-CsRegistrarConfiguration](Remove-CsRegistrarConfiguration.md) -{{Manually Enter Remove-CsRegistrarConfiguration Description Here}} - ### [Remove-CsReportingConfiguration](Remove-CsReportingConfiguration.md) -{{Manually Enter Remove-CsReportingConfiguration Description Here}} - ### [Remove-CsRgsAgentGroup](Remove-CsRgsAgentGroup.md) -{{Manually Enter Remove-CsRgsAgentGroup Description Here}} - ### [Remove-CsRgsHolidaySet](Remove-CsRgsHolidaySet.md) -{{Manually Enter Remove-CsRgsHolidaySet Description Here}} - ### [Remove-CsRgsHoursOfBusiness](Remove-CsRgsHoursOfBusiness.md) -{{Manually Enter Remove-CsRgsHoursOfBusiness Description Here}} - ### [Remove-CsRgsQueue](Remove-CsRgsQueue.md) -{{Manually Enter Remove-CsRgsQueue Description Here}} - ### [Remove-CsRgsWorkflow](Remove-CsRgsWorkflow.md) -{{Manually Enter Remove-CsRgsWorkflow Description Here}} - ### [Remove-CsRoutingConfiguration](Remove-CsRoutingConfiguration.md) -{{Manually Enter Remove-CsRoutingConfiguration Description Here}} - ### [Remove-CsServerApplication](Remove-CsServerApplication.md) -{{Manually Enter Remove-CsServerApplication Description Here}} - ### [Remove-CsSimpleUrlConfiguration](Remove-CsSimpleUrlConfiguration.md) -{{Manually Enter Remove-CsSimpleUrlConfiguration Description Here}} - ### [Remove-CsSipDomain](Remove-CsSipDomain.md) -{{Manually Enter Remove-CsSipDomain Description Here}} - ### [Remove-CsSipResponseCodeTranslationRule](Remove-CsSipResponseCodeTranslationRule.md) -{{Manually Enter Remove-CsSipResponseCodeTranslationRule Description Here}} - ### [Remove-CsSlaConfiguration](Remove-CsSlaConfiguration.md) -{{Manually Enter Remove-CsSlaConfiguration Description Here}} - ### [Remove-CsSlaDelegates](Remove-CsSlaDelegates.md) -{{Manually Enter Remove-CsSlaDelegates Description Here}} - ### [Remove-CsStaticRoutingConfiguration](Remove-CsStaticRoutingConfiguration.md) -{{Manually Enter Remove-CsStaticRoutingConfiguration Description Here}} - ### [Remove-CsStorageServiceConfiguration](Remove-CsStorageServiceConfiguration.md) -{{Manually Enter Remove-CsStorageServiceConfiguration Description Here}} - -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) -{{Manually Enter Remove-CsTeamsMeetingPolicy Description Here}} - +### [Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) ### [Remove-CsTelemetryConfiguration](Remove-CsTelemetryConfiguration.md) -{{Manually Enter Remove-CsTelemetryConfiguration Description Here}} - -### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) -{{Manually Enter Remove-CsTenantDialPlan Description Here}} - -### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) -{{Manually Enter Remove-CsTenantNetworkRegion Description Here}} - -### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) -{{Manually Enter Remove-CsTenantNetworkSite Description Here}} - -### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) -{{Manually Enter Remove-CsTenantNetworkSubnet Description Here}} - -### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) -{{Manually Enter Remove-CsTenantTrustedIPAddress Description Here}} - -### [Remove-CsTenantUpdateTimeWindow](Remove-CsTenantUpdateTimeWindow.md) -{{Manually Enter Remove-CsTenantUpdateTimeWindow Description Here}} - ### [Remove-CsTestDevice](Remove-CsTestDevice.md) -{{Manually Enter Remove-CsTestDevice Description Here}} - ### [Remove-CsTestUserCredential](Remove-CsTestUserCredential.md) -{{Manually Enter Remove-CsTestUserCredential Description Here}} - ### [Remove-CsThirdPartyVideoSystem](Remove-CsThirdPartyVideoSystem.md) -{{Manually Enter Remove-CsThirdPartyVideoSystem Description Here}} - ### [Remove-CsThirdPartyVideoSystemPolicy](Remove-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Remove-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Remove-CsTrunkConfiguration](Remove-CsTrunkConfiguration.md) -{{Manually Enter Remove-CsTrunkConfiguration Description Here}} - ### [Remove-CsTrustedApplication](Remove-CsTrustedApplication.md) -{{Manually Enter Remove-CsTrustedApplication Description Here}} - ### [Remove-CsTrustedApplicationComputer](Remove-CsTrustedApplicationComputer.md) -{{Manually Enter Remove-CsTrustedApplicationComputer Description Here}} - ### [Remove-CsTrustedApplicationEndpoint](Remove-CsTrustedApplicationEndpoint.md) -{{Manually Enter Remove-CsTrustedApplicationEndpoint Description Here}} - ### [Remove-CsTrustedApplicationPool](Remove-CsTrustedApplicationPool.md) -{{Manually Enter Remove-CsTrustedApplicationPool Description Here}} - ### [Remove-CsUCPhoneConfiguration](Remove-CsUCPhoneConfiguration.md) -{{Manually Enter Remove-CsUCPhoneConfiguration Description Here}} - ### [Remove-CsUnassignedNumber](Remove-CsUnassignedNumber.md) -{{Manually Enter Remove-CsUnassignedNumber Description Here}} - ### [Remove-CsUserAcp](Remove-CsUserAcp.md) -{{Manually Enter Remove-CsUserAcp Description Here}} - ### [Remove-CsUserReplicatorConfiguration](Remove-CsUserReplicatorConfiguration.md) -{{Manually Enter Remove-CsUserReplicatorConfiguration Description Here}} - ### [Remove-CsUserServicesConfiguration](Remove-CsUserServicesConfiguration.md) -{{Manually Enter Remove-CsUserServicesConfiguration Description Here}} - ### [Remove-CsUserServicesPolicy](Remove-CsUserServicesPolicy.md) -{{Manually Enter Remove-CsUserServicesPolicy Description Here}} - ### [Remove-CsUserStoreBackupData](Remove-CsUserStoreBackupData.md) -{{Manually Enter Remove-CsUserStoreBackupData Description Here}} - ### [Remove-CsVideoInteropServerConfiguration](Remove-CsVideoInteropServerConfiguration.md) -{{Manually Enter Remove-CsVideoInteropServerConfiguration Description Here}} - ### [Remove-CsVideoInteropServerSyntheticTransactionConfiguration](Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter Remove-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [Remove-CsVideoTrunkConfiguration](Remove-CsVideoTrunkConfiguration.md) -{{Manually Enter Remove-CsVideoTrunkConfiguration Description Here}} - ### [Remove-CsVoiceConfiguration](Remove-CsVoiceConfiguration.md) -{{Manually Enter Remove-CsVoiceConfiguration Description Here}} - ### [Remove-CsVoicemailReroutingConfiguration](Remove-CsVoicemailReroutingConfiguration.md) -{{Manually Enter Remove-CsVoicemailReroutingConfiguration Description Here}} - ### [Remove-CsVoiceNormalizationRule](Remove-CsVoiceNormalizationRule.md) -{{Manually Enter Remove-CsVoiceNormalizationRule Description Here}} - ### [Remove-CsVoicePolicy](Remove-CsVoicePolicy.md) -{{Manually Enter Remove-CsVoicePolicy Description Here}} - ### [Remove-CsVoiceRoute](Remove-CsVoiceRoute.md) -{{Manually Enter Remove-CsVoiceRoute Description Here}} - ### [Remove-CsVoiceRoutingPolicy](Remove-CsVoiceRoutingPolicy.md) -{{Manually Enter Remove-CsVoiceRoutingPolicy Description Here}} - ### [Remove-CsVoiceTestConfiguration](Remove-CsVoiceTestConfiguration.md) -{{Manually Enter Remove-CsVoiceTestConfiguration Description Here}} - ### [Remove-CsWatcherNodeConfiguration](Remove-CsWatcherNodeConfiguration.md) -{{Manually Enter Remove-CsWatcherNodeConfiguration Description Here}} - ### [Remove-CsWebServiceConfiguration](Remove-CsWebServiceConfiguration.md) -{{Manually Enter Remove-CsWebServiceConfiguration Description Here}} - ### [Remove-CsXmppAllowedPartner](Remove-CsXmppAllowedPartner.md) -{{Manually Enter Remove-CsXmppAllowedPartner Description Here}} - ### [Request-CsCertificate](Request-CsCertificate.md) -{{Manually Enter Request-CsCertificate Description Here}} - ### [Reset-CsDeviceUpdateRule](Reset-CsDeviceUpdateRule.md) -{{Manually Enter Reset-CsDeviceUpdateRule Description Here}} - ### [Reset-CsNotificationQueues](Reset-CsNotificationQueues.md) -{{Manually Enter Reset-CsNotificationQueues Description Here}} - ### [Reset-CsPoolRegistrarState](Reset-CsPoolRegistrarState.md) -{{Manually Enter Reset-CsPoolRegistrarState Description Here}} - ### [Reset-CsRoutingGroup](Reset-CsRoutingGroup.md) -{{Manually Enter Reset-CsRoutingGroup Description Here}} - ### [Restore-CsDeviceUpdateRule](Restore-CsDeviceUpdateRule.md) -{{Manually Enter Restore-CsDeviceUpdateRule Description Here}} - ### [Revoke-CsClientCertificate](Revoke-CsClientCertificate.md) -{{Manually Enter Revoke-CsClientCertificate Description Here}} - ### [Revoke-CsOUPermission](Revoke-CsOUPermission.md) -{{Manually Enter Revoke-CsOUPermission Description Here}} - ### [Revoke-CsSetupPermission](Revoke-CsSetupPermission.md) -{{Manually Enter Revoke-CsSetupPermission Description Here}} - ### [Search-CsClsLogging](Search-CsClsLogging.md) -{{Manually Enter Search-CsClsLogging Description Here}} - -### [Search-CsOnlineTelephoneNumberInventory](Search-CsOnlineTelephoneNumberInventory.md) -{{Manually Enter Search-CsOnlineTelephoneNumberInventory Description Here}} - -### [Select-CsOnlineTelephoneNumberInventory](Select-CsOnlineTelephoneNumberInventory.md) -{{Manually Enter Select-CsOnlineTelephoneNumberInventory Description Here}} - ### [Set-CsAccessEdgeConfiguration](Set-CsAccessEdgeConfiguration.md) -{{Manually Enter Set-CsAccessEdgeConfiguration Description Here}} - ### [Set-CsAddressBookConfiguration](Set-CsAddressBookConfiguration.md) -{{Manually Enter Set-CsAddressBookConfiguration Description Here}} - ### [Set-CsAddressBookNormalizationConfiguration](Set-CsAddressBookNormalizationConfiguration.md) -{{Manually Enter Set-CsAddressBookNormalizationConfiguration Description Here}} - ### [Set-CsAddressBookNormalizationRule](Set-CsAddressBookNormalizationRule.md) -{{Manually Enter Set-CsAddressBookNormalizationRule Description Here}} - ### [Set-CsAdminRole](Set-CsAdminRole.md) -{{Manually Enter Set-CsAdminRole Description Here}} - ### [Set-CsAllowedDomain](Set-CsAllowedDomain.md) -{{Manually Enter Set-CsAllowedDomain Description Here}} - ### [Set-CsAnalogDevice](Set-CsAnalogDevice.md) -{{Manually Enter Set-CsAnalogDevice Description Here}} - ### [Set-CsAnnouncement](Set-CsAnnouncement.md) -{{Manually Enter Set-CsAnnouncement Description Here}} - ### [Set-CsApplicationServer](Set-CsApplicationServer.md) -{{Manually Enter Set-CsApplicationServer Description Here}} - ### [Set-CsArchivingConfiguration](Set-CsArchivingConfiguration.md) -{{Manually Enter Set-CsArchivingConfiguration Description Here}} - ### [Set-CsArchivingPolicy](Set-CsArchivingPolicy.md) -{{Manually Enter Set-CsArchivingPolicy Description Here}} - ### [Set-CsArchivingServer](Set-CsArchivingServer.md) -{{Manually Enter Set-CsArchivingServer Description Here}} - ### [Set-CsAudioTestServiceApplication](Set-CsAudioTestServiceApplication.md) -{{Manually Enter Set-CsAudioTestServiceApplication Description Here}} - +### [Set-CsAuthConfig](Set-CsAuthConfig.md) ### [Set-CsAutodiscoverConfiguration](Set-CsAutodiscoverConfiguration.md) -{{Manually Enter Set-CsAutodiscoverConfiguration Description Here}} - ### [Set-CsAVEdgeConfiguration](Set-CsAVEdgeConfiguration.md) -{{Manually Enter Set-CsAVEdgeConfiguration Description Here}} - ### [Set-CsBackupServiceConfiguration](Set-CsBackupServiceConfiguration.md) -{{Manually Enter Set-CsBackupServiceConfiguration Description Here}} - ### [Set-CsBandwidthPolicyServiceConfiguration](Set-CsBandwidthPolicyServiceConfiguration.md) -{{Manually Enter Set-CsBandwidthPolicyServiceConfiguration Description Here}} - ### [Set-CsBlockedDomain](Set-CsBlockedDomain.md) -{{Manually Enter Set-CsBlockedDomain Description Here}} - -### [Set-CsBroadcastMeetingConfiguration](Set-CsBroadcastMeetingConfiguration.md) -{{Manually Enter Set-CsBroadcastMeetingConfiguration Description Here}} - ### [Set-CsBusyOptions](Set-CsBusyOptions.md) -{{Manually Enter Set-CsBusyOptions Description Here}} - -### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) -{{Manually Enter Set-CsCallingLineIdentity Description Here}} - ### [Set-CsCallParkOrbit](Set-CsCallParkOrbit.md) -{{Manually Enter Set-CsCallParkOrbit Description Here}} - ### [Set-CsCallParkServiceMusicOnHoldFile](Set-CsCallParkServiceMusicOnHoldFile.md) -{{Manually Enter Set-CsCallParkServiceMusicOnHoldFile Description Here}} - ### [Set-CsCallViaWorkPolicy](Set-CsCallViaWorkPolicy.md) -{{Manually Enter Set-CsCallViaWorkPolicy Description Here}} - -### [Set-CsCceApplianceConfigurationReplicationStatus](Set-CsCceApplianceConfigurationReplicationStatus.md) -{{Manually Enter Set-CsCceApplianceConfigurationReplicationStatus Description Here}} - -### [Set-CsCceApplianceDeploymentStatus](Set-CsCceApplianceDeploymentStatus.md) -{{Manually Enter Set-CsCceApplianceDeploymentStatus Description Here}} - -### [Set-CsCceApplianceStatus](Set-CsCceApplianceStatus.md) -{{Manually Enter Set-CsCceApplianceStatus Description Here}} - ### [Set-CsCdrConfiguration](Set-CsCdrConfiguration.md) -{{Manually Enter Set-CsCdrConfiguration Description Here}} - ### [Set-CsCertificate](Set-CsCertificate.md) -{{Manually Enter Set-CsCertificate Description Here}} - ### [Set-CsClientPin](Set-CsClientPin.md) -{{Manually Enter Set-CsClientPin Description Here}} - ### [Set-CsClientPolicy](Set-CsClientPolicy.md) -{{Manually Enter Set-CsClientPolicy Description Here}} - ### [Set-CsClientVersionConfiguration](Set-CsClientVersionConfiguration.md) -{{Manually Enter Set-CsClientVersionConfiguration Description Here}} - ### [Set-CsClientVersionPolicy](Set-CsClientVersionPolicy.md) -{{Manually Enter Set-CsClientVersionPolicy Description Here}} - ### [Set-CsClientVersionPolicyRule](Set-CsClientVersionPolicyRule.md) -{{Manually Enter Set-CsClientVersionPolicyRule Description Here}} - +### [Set-CsCloudCallDataConnector](Set-CsCloudCallDataConnector.md) +### [Set-CsCloudCallDataConnectorConfiguration](Set-CsCloudCallDataConnectorConfiguration.md) ### [Set-CsClsConfiguration](Set-CsClsConfiguration.md) -{{Manually Enter Set-CsClsConfiguration Description Here}} - ### [Set-CsClsRegion](Set-CsClsRegion.md) -{{Manually Enter Set-CsClsRegion Description Here}} - ### [Set-CsClsScenario](Set-CsClsScenario.md) -{{Manually Enter Set-CsClsScenario Description Here}} - ### [Set-CsClsSearchTerm](Set-CsClsSearchTerm.md) -{{Manually Enter Set-CsClsSearchTerm Description Here}} - ### [Set-CsClsSecurityGroup](Set-CsClsSecurityGroup.md) -{{Manually Enter Set-CsClsSecurityGroup Description Here}} - ### [Set-CsCommonAreaPhone](Set-CsCommonAreaPhone.md) -{{Manually Enter Set-CsCommonAreaPhone Description Here}} - ### [Set-CsConferenceDisclaimer](Set-CsConferenceDisclaimer.md) -{{Manually Enter Set-CsConferenceDisclaimer Description Here}} - ### [Set-CsConferenceServer](Set-CsConferenceServer.md) -{{Manually Enter Set-CsConferenceServer Description Here}} - ### [Set-CsConferencingConfiguration](Set-CsConferencingConfiguration.md) -{{Manually Enter Set-CsConferencingConfiguration Description Here}} - ### [Set-CsConferencingPolicy](Set-CsConferencingPolicy.md) -{{Manually Enter Set-CsConferencingPolicy Description Here}} - ### [Set-CsConfigurationStoreLocation](Set-CsConfigurationStoreLocation.md) -{{Manually Enter Set-CsConfigurationStoreLocation Description Here}} - ### [Set-CsConversationHistoryConfiguration](Set-CsConversationHistoryConfiguration.md) -{{Manually Enter Set-CsConversationHistoryConfiguration Description Here}} - ### [Set-CsCpsConfiguration](Set-CsCpsConfiguration.md) -{{Manually Enter Set-CsCpsConfiguration Description Here}} - ### [Set-CsDeviceUpdateConfiguration](Set-CsDeviceUpdateConfiguration.md) -{{Manually Enter Set-CsDeviceUpdateConfiguration Description Here}} - ### [Set-CsDiagnosticConfiguration](Set-CsDiagnosticConfiguration.md) -{{Manually Enter Set-CsDiagnosticConfiguration Description Here}} - ### [Set-CsDiagnosticHeaderConfiguration](Set-CsDiagnosticHeaderConfiguration.md) -{{Manually Enter Set-CsDiagnosticHeaderConfiguration Description Here}} - ### [Set-CsDialInConferencingAccessNumber](Set-CsDialInConferencingAccessNumber.md) -{{Manually Enter Set-CsDialInConferencingAccessNumber Description Here}} - ### [Set-CsDialInConferencingConfiguration](Set-CsDialInConferencingConfiguration.md) -{{Manually Enter Set-CsDialInConferencingConfiguration Description Here}} - ### [Set-CsDialInConferencingDtmfConfiguration](Set-CsDialInConferencingDtmfConfiguration.md) -{{Manually Enter Set-CsDialInConferencingDtmfConfiguration Description Here}} - ### [Set-CsDialPlan](Set-CsDialPlan.md) -{{Manually Enter Set-CsDialPlan Description Here}} - ### [Set-CsDirector](Set-CsDirector.md) -{{Manually Enter Set-CsDirector Description Here}} - ### [Set-CsEdgeServer](Set-CsEdgeServer.md) -{{Manually Enter Set-CsEdgeServer Description Here}} - ### [Set-CsEnhancedEmergencyServiceDisclaimer](Set-CsEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Set-CsEnhancedEmergencyServiceDisclaimer Description Here}} - ### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) -{{Manually Enter Set-CsExternalAccessPolicy Description Here}} - -### [Set-CsExternalUserCommunicationPolicy](Set-CsExternalUserCommunicationPolicy.md) -{{Manually Enter Set-CsExternalUserCommunicationPolicy Description Here}} - ### [Set-CsExUmContact](Set-CsExUmContact.md) -{{Manually Enter Set-CsExUmContact Description Here}} - ### [Set-CsFileTransferFilterConfiguration](Set-CsFileTransferFilterConfiguration.md) -{{Manually Enter Set-CsFileTransferFilterConfiguration Description Here}} - ### [Set-CsFIPSConfiguration](Set-CsFIPSConfiguration.md) -{{Manually Enter Set-CsFIPSConfiguration Description Here}} - ### [Set-CsGroupPickupUserOrbit](Set-CsGroupPickupUserOrbit.md) -{{Manually Enter Set-CsGroupPickupUserOrbit Description Here}} - ### [Set-CsHealthMonitoringConfiguration](Set-CsHealthMonitoringConfiguration.md) -{{Manually Enter Set-CsHealthMonitoringConfiguration Description Here}} - ### [Set-CsHostedVoicemailPolicy](Set-CsHostedVoicemailPolicy.md) -{{Manually Enter Set-CsHostedVoicemailPolicy Description Here}} - ### [Set-CsHostingProvider](Set-CsHostingProvider.md) -{{Manually Enter Set-CsHostingProvider Description Here}} - -### [Set-CsHuntGroup](Set-CsHuntGroup.md) -{{Manually Enter Set-CsHuntGroup Description Here}} - -### [Set-CsHybridMediationServer](Set-CsHybridMediationServer.md) -{{Manually Enter Set-CsHybridMediationServer Description Here}} - -### [Set-CsHybridPSTNAppliance](Set-CsHybridPSTNAppliance.md) -{{Manually Enter Set-CsHybridPSTNAppliance Description Here}} - -### [Set-CsHybridPSTNSite](Set-CsHybridPSTNSite.md) -{{Manually Enter Set-CsHybridPSTNSite Description Here}} - +### [Set-CsHybridApplicationEndpoint](Set-CsHybridApplicationEndpoint.md) ### [Set-CsImConfiguration](Set-CsImConfiguration.md) -{{Manually Enter Set-CsImConfiguration Description Here}} - ### [Set-CsImFilterConfiguration](Set-CsImFilterConfiguration.md) -{{Manually Enter Set-CsImFilterConfiguration Description Here}} - ### [Set-CsImTranslationConfiguration](Set-CsImTranslationConfiguration.md) -{{Manually Enter Set-CsImTranslationConfiguration Description Here}} - ### [Set-CsIPPhonePolicy](Set-CsIPPhonePolicy.md) -{{Manually Enter Set-CsIPPhonePolicy Description Here}} - ### [Set-CsKerberosAccountAssignment](Set-CsKerberosAccountAssignment.md) -{{Manually Enter Set-CsKerberosAccountAssignment Description Here}} - ### [Set-CsKerberosAccountPassword](Set-CsKerberosAccountPassword.md) -{{Manually Enter Set-CsKerberosAccountPassword Description Here}} - ### [Set-CsLisLocation](Set-CsLisLocation.md) -{{Manually Enter Set-CsLisLocation Description Here}} - ### [Set-CsLisPort](Set-CsLisPort.md) -{{Manually Enter Set-CsLisPort Description Here}} - ### [Set-CsLisServiceProvider](Set-CsLisServiceProvider.md) -{{Manually Enter Set-CsLisServiceProvider Description Here}} - ### [Set-CsLisSubnet](Set-CsLisSubnet.md) -{{Manually Enter Set-CsLisSubnet Description Here}} - ### [Set-CsLisSwitch](Set-CsLisSwitch.md) -{{Manually Enter Set-CsLisSwitch Description Here}} - ### [Set-CsLisWirelessAccessPoint](Set-CsLisWirelessAccessPoint.md) -{{Manually Enter Set-CsLisWirelessAccessPoint Description Here}} - ### [Set-CsLocationPolicy](Set-CsLocationPolicy.md) -{{Manually Enter Set-CsLocationPolicy Description Here}} - ### [Set-CsManagementConnection](Set-CsManagementConnection.md) -{{Manually Enter Set-CsManagementConnection Description Here}} - ### [Set-CsManagementServer](Set-CsManagementServer.md) -{{Manually Enter Set-CsManagementServer Description Here}} - ### [Set-CsMcxConfiguration](Set-CsMcxConfiguration.md) -{{Manually Enter Set-CsMcxConfiguration Description Here}} - ### [Set-CsMediaConfiguration](Set-CsMediaConfiguration.md) -{{Manually Enter Set-CsMediaConfiguration Description Here}} - ### [Set-CsMediationServer](Set-CsMediationServer.md) -{{Manually Enter Set-CsMediationServer Description Here}} - ### [Set-CsMeetingConfiguration](Set-CsMeetingConfiguration.md) -{{Manually Enter Set-CsMeetingConfiguration Description Here}} - ### [Set-CsMeetingRoom](Set-CsMeetingRoom.md) -{{Manually Enter Set-CsMeetingRoom Description Here}} - ### [Set-CsMobilityPolicy](Set-CsMobilityPolicy.md) -{{Manually Enter Set-CsMobilityPolicy Description Here}} - ### [Set-CsMonitoringServer](Set-CsMonitoringServer.md) -{{Manually Enter Set-CsMonitoringServer Description Here}} - ### [Set-CsNetworkBandwidthPolicyProfile](Set-CsNetworkBandwidthPolicyProfile.md) -{{Manually Enter Set-CsNetworkBandwidthPolicyProfile Description Here}} - ### [Set-CsNetworkConfiguration](Set-CsNetworkConfiguration.md) -{{Manually Enter Set-CsNetworkConfiguration Description Here}} - ### [Set-CsNetworkInterRegionRoute](Set-CsNetworkInterRegionRoute.md) -{{Manually Enter Set-CsNetworkInterRegionRoute Description Here}} - ### [Set-CsNetworkInterSitePolicy](Set-CsNetworkInterSitePolicy.md) -{{Manually Enter Set-CsNetworkInterSitePolicy Description Here}} - ### [Set-CsNetworkRegion](Set-CsNetworkRegion.md) -{{Manually Enter Set-CsNetworkRegion Description Here}} - ### [Set-CsNetworkRegionLink](Set-CsNetworkRegionLink.md) -{{Manually Enter Set-CsNetworkRegionLink Description Here}} - ### [Set-CsNetworkSite](Set-CsNetworkSite.md) -{{Manually Enter Set-CsNetworkSite Description Here}} - ### [Set-CsNetworkSubnet](Set-CsNetworkSubnet.md) -{{Manually Enter Set-CsNetworkSubnet Description Here}} - ### [Set-CsOAuthConfiguration](Set-CsOAuthConfiguration.md) -{{Manually Enter Set-CsOAuthConfiguration Description Here}} - ### [Set-CsOAuthServer](Set-CsOAuthServer.md) -{{Manually Enter Set-CsOAuthServer Description Here}} - -### [Set-CsOnlineApplicationEndpoint](Set-CsOnlineApplicationEndpoint.md) -{{Manually Enter Set-CsOnlineApplicationEndpoint Description Here}} - -### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) -{{Manually Enter Set-CsOnlineDialInConferencingBridge Description Here}} - -### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Set-CsOnlineDialInConferencingServiceNumber Description Here}} - -### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) -{{Manually Enter Set-CsOnlineDialInConferencingTenantSettings Description Here}} - -### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) -{{Manually Enter Set-CsOnlineDialInConferencingUser Description Here}} - ### [Set-CsOnlineDialInConferencingUserDefaultNumber](Set-CsOnlineDialInConferencingUserDefaultNumber.md) -{{Manually Enter Set-CsOnlineDialInConferencingUserDefaultNumber Description Here}} - ### [Set-CsOnlineDirectoryUser](Set-CsOnlineDirectoryUser.md) -{{Manually Enter Set-CsOnlineDirectoryUser Description Here}} - -### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) -{{Manually Enter Set-CsOnlineEnhancedEmergencyServiceDisclaimer Description Here}} - -### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) -{{Manually Enter Set-CsOnlineLisCivicAddress Description Here}} - -### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) -{{Manually Enter Set-CsOnlineLisLocation Description Here}} - ### [Set-CsOnlineNumberPortInOrder](Set-CsOnlineNumberPortInOrder.md) -{{Manually Enter Set-CsOnlineNumberPortInOrder Description Here}} - ### [Set-CsOnlineNumberPortOutOrderPin](Set-CsOnlineNumberPortOutOrderPin.md) -{{Manually Enter Set-CsOnlineNumberPortOutOrderPin Description Here}} - -### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) -{{Manually Enter Set-CsOnlinePSTNGateway Description Here}} - -### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) -{{Manually Enter Set-CsOnlineVoicemailPolicy Description Here}} - -### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) -{{Manually Enter Set-CsOnlineVoiceUser Description Here}} - ### [Set-CsOnlineVoiceUserBulk](Set-CsOnlineVoiceUserBulk.md) -{{Manually Enter Set-CsOnlineVoiceUserBulk Description Here}} - -### [Set-CsOrganizationalAutoAttendant](Set-CsOrganizationalAutoAttendant.md) -{{Manually Enter Set-CsOrganizationalAutoAttendant Description Here}} - ### [Set-CsOutboundCallingNumberTranslationRule](Set-CsOutboundCallingNumberTranslationRule.md) -{{Manually Enter Set-CsOutboundCallingNumberTranslationRule Description Here}} - ### [Set-CsOutboundTranslationRule](Set-CsOutboundTranslationRule.md) -{{Manually Enter Set-CsOutboundTranslationRule Description Here}} - ### [Set-CsPartnerApplication](Set-CsPartnerApplication.md) -{{Manually Enter Set-CsPartnerApplication Description Here}} - ### [Set-CsPersistentChatActiveServer](Set-CsPersistentChatActiveServer.md) -{{Manually Enter Set-CsPersistentChatActiveServer Description Here}} - ### [Set-CsPersistentChatAddin](Set-CsPersistentChatAddin.md) -{{Manually Enter Set-CsPersistentChatAddin Description Here}} - ### [Set-CsPersistentChatCategory](Set-CsPersistentChatCategory.md) -{{Manually Enter Set-CsPersistentChatCategory Description Here}} - ### [Set-CsPersistentChatComplianceConfiguration](Set-CsPersistentChatComplianceConfiguration.md) -{{Manually Enter Set-CsPersistentChatComplianceConfiguration Description Here}} - ### [Set-CsPersistentChatConfiguration](Set-CsPersistentChatConfiguration.md) -{{Manually Enter Set-CsPersistentChatConfiguration Description Here}} - ### [Set-CsPersistentChatPolicy](Set-CsPersistentChatPolicy.md) -{{Manually Enter Set-CsPersistentChatPolicy Description Here}} - ### [Set-CsPersistentChatRoom](Set-CsPersistentChatRoom.md) -{{Manually Enter Set-CsPersistentChatRoom Description Here}} - ### [Set-CsPersistentChatState](Set-CsPersistentChatState.md) -{{Manually Enter Set-CsPersistentChatState Description Here}} - ### [Set-CsPinPolicy](Set-CsPinPolicy.md) -{{Manually Enter Set-CsPinPolicy Description Here}} - +### [Set-CsPlatformServiceSettings](Set-CsPlatformServiceSettings.md) ### [Set-CsPresenceManagementState](Set-CsPresenceManagementState.md) -{{Manually Enter Set-CsPresenceManagementState Description Here}} - ### [Set-CsPresencePolicy](Set-CsPresencePolicy.md) -{{Manually Enter Set-CsPresencePolicy Description Here}} - ### [Set-CsPresenceProvider](Set-CsPresenceProvider.md) -{{Manually Enter Set-CsPresenceProvider Description Here}} - ### [Set-CsPrivacyConfiguration](Set-CsPrivacyConfiguration.md) -{{Manually Enter Set-CsPrivacyConfiguration Description Here}} - ### [Set-CsProxyConfiguration](Set-CsProxyConfiguration.md) -{{Manually Enter Set-CsProxyConfiguration Description Here}} - ### [Set-CsPstnGateway](Set-CsPstnGateway.md) -{{Manually Enter Set-CsPstnGateway Description Here}} - ### [Set-CsPstnUsage](Set-CsPstnUsage.md) -{{Manually Enter Set-CsPstnUsage Description Here}} - ### [Set-CsPublicProvider](Set-CsPublicProvider.md) -{{Manually Enter Set-CsPublicProvider Description Here}} - ### [Set-CsPushNotificationConfiguration](Set-CsPushNotificationConfiguration.md) -{{Manually Enter Set-CsPushNotificationConfiguration Description Here}} - ### [Set-CsQoEConfiguration](Set-CsQoEConfiguration.md) -{{Manually Enter Set-CsQoEConfiguration Description Here}} - ### [Set-CsRegistrar](Set-CsRegistrar.md) -{{Manually Enter Set-CsRegistrar Description Here}} - ### [Set-CsRegistrarConfiguration](Set-CsRegistrarConfiguration.md) -{{Manually Enter Set-CsRegistrarConfiguration Description Here}} - ### [Set-CsReportingConfiguration](Set-CsReportingConfiguration.md) -{{Manually Enter Set-CsReportingConfiguration Description Here}} - ### [Set-CsRgsAgentGroup](Set-CsRgsAgentGroup.md) -{{Manually Enter Set-CsRgsAgentGroup Description Here}} - ### [Set-CsRgsConfiguration](Set-CsRgsConfiguration.md) -{{Manually Enter Set-CsRgsConfiguration Description Here}} - ### [Set-CsRgsHolidaySet](Set-CsRgsHolidaySet.md) -{{Manually Enter Set-CsRgsHolidaySet Description Here}} - ### [Set-CsRgsHoursOfBusiness](Set-CsRgsHoursOfBusiness.md) -{{Manually Enter Set-CsRgsHoursOfBusiness Description Here}} - ### [Set-CsRgsQueue](Set-CsRgsQueue.md) -{{Manually Enter Set-CsRgsQueue Description Here}} - ### [Set-CsRgsWorkflow](Set-CsRgsWorkflow.md) -{{Manually Enter Set-CsRgsWorkflow Description Here}} - ### [Set-CsRoutingConfiguration](Set-CsRoutingConfiguration.md) -{{Manually Enter Set-CsRoutingConfiguration Description Here}} - ### [Set-CsServerApplication](Set-CsServerApplication.md) -{{Manually Enter Set-CsServerApplication Description Here}} - ### [Set-CsSimpleUrlConfiguration](Set-CsSimpleUrlConfiguration.md) -{{Manually Enter Set-CsSimpleUrlConfiguration Description Here}} - ### [Set-CsSipDomain](Set-CsSipDomain.md) -{{Manually Enter Set-CsSipDomain Description Here}} - ### [Set-CsSipResponseCodeTranslationRule](Set-CsSipResponseCodeTranslationRule.md) -{{Manually Enter Set-CsSipResponseCodeTranslationRule Description Here}} - ### [Set-CsSite](Set-CsSite.md) -{{Manually Enter Set-CsSite Description Here}} - ### [Set-CsSlaConfiguration](Set-CsSlaConfiguration.md) -{{Manually Enter Set-CsSlaConfiguration Description Here}} - ### [Set-CsStaticRoutingConfiguration](Set-CsStaticRoutingConfiguration.md) -{{Manually Enter Set-CsStaticRoutingConfiguration Description Here}} - ### [Set-CsStorageServiceConfiguration](Set-CsStorageServiceConfiguration.md) -{{Manually Enter Set-CsStorageServiceConfiguration Description Here}} - -### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) -{{Manually Enter Set-CsTeamsCallingPolicy Description Here}} - -### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) -{{Manually Enter Set-CsTeamsMobilityPolicy Description Here}} - -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) -{{Manually Enter Set-CsTeamsMeetingPolicy Description Here}} - +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +### [Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) ### [Set-CsTelemetryConfiguration](Set-CsTelemetryConfiguration.md) -{{Manually Enter Set-CsTelemetryConfiguration Description Here}} - -### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) -{{Manually Enter Set-CsTenantDialPlan Description Here}} - -### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) -{{Manually Enter Set-CsTenantNetworkRegion Description Here}} - -### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) -{{Manually Enter Set-CsTenantNetworkSite Description Here}} - -### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) -{{Manually Enter Set-CsTenantNetworkSubnet Description Here}} - -### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) -{{Manually Enter Set-CsTenantTrustedIPAddress Description Here}} - -### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) -{{Manually Enter Set-CsTenantFederationConfiguration Description Here}} - ### [Set-CsTenantHybridConfiguration](Set-CsTenantHybridConfiguration.md) -{{Manually Enter Set-CsTenantHybridConfiguration Description Here}} - -### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) -{{Manually Enter Set-CsTenantMigrationConfiguration Description Here}} - -### [Set-CsTenantPublicProvider](Set-CsTenantPublicProvider.md) -{{Manually Enter Set-CsTenantPublicProvider Description Here}} - -### [Set-CsTenantUpdateTimeWindow](Set-CsTenantUpdateTimeWindow.md) -{{Manually Enter Set-CsTenantUpdateTimeWindow Description Here}} - ### [Set-CsTestDevice](Set-CsTestDevice.md) -{{Manually Enter Set-CsTestDevice Description Here}} - ### [Set-CsTestUserCredential](Set-CsTestUserCredential.md) -{{Manually Enter Set-CsTestUserCredential Description Here}} - ### [Set-CsThirdPartyVideoSystem](Set-CsThirdPartyVideoSystem.md) -{{Manually Enter Set-CsThirdPartyVideoSystem Description Here}} - ### [Set-CsThirdPartyVideoSystemPolicy](Set-CsThirdPartyVideoSystemPolicy.md) -{{Manually Enter Set-CsThirdPartyVideoSystemPolicy Description Here}} - ### [Set-CsTrunkConfiguration](Set-CsTrunkConfiguration.md) -{{Manually Enter Set-CsTrunkConfiguration Description Here}} - ### [Set-CsTrustedApplication](Set-CsTrustedApplication.md) -{{Manually Enter Set-CsTrustedApplication Description Here}} - ### [Set-CsTrustedApplicationEndpoint](Set-CsTrustedApplicationEndpoint.md) -{{Manually Enter Set-CsTrustedApplicationEndpoint Description Here}} - ### [Set-CsTrustedApplicationPool](Set-CsTrustedApplicationPool.md) -{{Manually Enter Set-CsTrustedApplicationPool Description Here}} - ### [Set-CsUCPhoneConfiguration](Set-CsUCPhoneConfiguration.md) -{{Manually Enter Set-CsUCPhoneConfiguration Description Here}} - ### [Set-CsUICulture](Set-CsUICulture.md) -{{Manually Enter Set-CsUICulture Description Here}} - ### [Set-CsUnassignedNumber](Set-CsUnassignedNumber.md) -{{Manually Enter Set-CsUnassignedNumber Description Here}} - ### [Set-CsUser](Set-CsUser.md) -{{Manually Enter Set-CsUser Description Here}} - ### [Set-CsUserAcp](Set-CsUserAcp.md) -{{Manually Enter Set-CsUserAcp Description Here}} - ### [Set-CsUserCallForwardingSettings](Set-CsUserCallForwardingSettings.md) -{{Manually Enter Set-CsUserCallForwardingSettings Description Here}} - ### [Set-CsUserDatabaseState](Set-CsUserDatabaseState.md) -{{Manually Enter Set-CsUserDatabaseState Description Here}} - ### [Set-CsUserDelegates](Set-CsUserDelegates.md) -{{Manually Enter Set-CsUserDelegates Description Here}} - -### [Set-CsUserPstnSettings](Set-CsUserPstnSettings.md) -{{Manually Enter Set-CsUserPstnSettings Description Here}} - ### [Set-CsUserReplicatorConfiguration](Set-CsUserReplicatorConfiguration.md) -{{Manually Enter Set-CsUserReplicatorConfiguration Description Here}} - ### [Set-CsUserServer](Set-CsUserServer.md) -{{Manually Enter Set-CsUserServer Description Here}} - ### [Set-CsUserServicesConfiguration](Set-CsUserServicesConfiguration.md) -{{Manually Enter Set-CsUserServicesConfiguration Description Here}} - ### [Set-CsUserServicesPolicy](Set-CsUserServicesPolicy.md) -{{Manually Enter Set-CsUserServicesPolicy Description Here}} - ### [Set-CsUserTeamMembers](Set-CsUserTeamMembers.md) -{{Manually Enter Set-CsUserTeamMembers Description Here}} - ### [Set-CsVideoGateway](Set-CsVideoGateway.md) -{{Manually Enter Set-CsVideoGateway Description Here}} - ### [Set-CsVideoInteropServer](Set-CsVideoInteropServer.md) -{{Manually Enter Set-CsVideoInteropServer Description Here}} - ### [Set-CsVideoInteropServerConfiguration](Set-CsVideoInteropServerConfiguration.md) -{{Manually Enter Set-CsVideoInteropServerConfiguration Description Here}} - ### [Set-CsVideoInteropServerSyntheticTransactionConfiguration](Set-CsVideoInteropServerSyntheticTransactionConfiguration.md) -{{Manually Enter Set-CsVideoInteropServerSyntheticTransactionConfiguration Description Here}} - ### [Set-CsVideoTrunkConfiguration](Set-CsVideoTrunkConfiguration.md) -{{Manually Enter Set-CsVideoTrunkConfiguration Description Here}} - ### [Set-CsVoiceConfiguration](Set-CsVoiceConfiguration.md) -{{Manually Enter Set-CsVoiceConfiguration Description Here}} - ### [Set-CsVoicemailReroutingConfiguration](Set-CsVoicemailReroutingConfiguration.md) -{{Manually Enter Set-CsVoicemailReroutingConfiguration Description Here}} - ### [Set-CsVoiceNormalizationRule](Set-CsVoiceNormalizationRule.md) -{{Manually Enter Set-CsVoiceNormalizationRule Description Here}} - ### [Set-CsVoicePolicy](Set-CsVoicePolicy.md) -{{Manually Enter Set-CsVoicePolicy Description Here}} - ### [Set-CsVoiceRoute](Set-CsVoiceRoute.md) -{{Manually Enter Set-CsVoiceRoute Description Here}} - ### [Set-CsVoiceRoutingPolicy](Set-CsVoiceRoutingPolicy.md) -{{Manually Enter Set-CsVoiceRoutingPolicy Description Here}} - ### [Set-CsVoiceTestConfiguration](Set-CsVoiceTestConfiguration.md) -{{Manually Enter Set-CsVoiceTestConfiguration Description Here}} - ### [Set-CsWatcherNodeConfiguration](Set-CsWatcherNodeConfiguration.md) -{{Manually Enter Set-CsWatcherNodeConfiguration Description Here}} - ### [Set-CsWebServer](Set-CsWebServer.md) -{{Manually Enter Set-CsWebServer Description Here}} - ### [Set-CsWebServiceConfiguration](Set-CsWebServiceConfiguration.md) -{{Manually Enter Set-CsWebServiceConfiguration Description Here}} - ### [Set-CsXmppAllowedPartner](Set-CsXmppAllowedPartner.md) -{{Manually Enter Set-CsXmppAllowedPartner Description Here}} - ### [Set-CsXmppGatewayConfiguration](Set-CsXmppGatewayConfiguration.md) -{{Manually Enter Set-CsXmppGatewayConfiguration Description Here}} - ### [Show-CsClsLogging](Show-CsClsLogging.md) -{{Manually Enter Show-CsClsLogging Description Here}} - +### [skype](skype.md) ### [Start-CsClsLogging](Start-CsClsLogging.md) -{{Manually Enter Start-CsClsLogging Description Here}} - -### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) -{{Manually Enter Start-CsExMeetingMigration Description Here}} - ### [Start-CsPool](Start-CsPool.md) -{{Manually Enter Start-CsPool Description Here}} - ### [Start-CsWindowsService](Start-CsWindowsService.md) -{{Manually Enter Start-CsWindowsService Description Here}} - ### [Stop-CsClsLogging](Stop-CsClsLogging.md) -{{Manually Enter Stop-CsClsLogging Description Here}} - ### [Stop-CsWindowsService](Stop-CsWindowsService.md) -{{Manually Enter Stop-CsWindowsService Description Here}} - ### [Sync-CsClsLogging](Sync-CsClsLogging.md) -{{Manually Enter Sync-CsClsLogging Description Here}} - ### [Sync-CsUserData](Sync-CsUserData.md) -{{Manually Enter Sync-CsUserData Description Here}} - ### [Test-CsAddressBookService](Test-CsAddressBookService.md) -{{Manually Enter Test-CsAddressBookService Description Here}} - ### [Test-CsAddressBookWebQuery](Test-CsAddressBookWebQuery.md) -{{Manually Enter Test-CsAddressBookWebQuery Description Here}} - ### [Test-CsASConference](Test-CsASConference.md) -{{Manually Enter Test-CsASConference Description Here}} - ### [Test-CsAudioConferencingProvider](Test-CsAudioConferencingProvider.md) -{{Manually Enter Test-CsAudioConferencingProvider Description Here}} - ### [Test-CsAVConference](Test-CsAVConference.md) -{{Manually Enter Test-CsAVConference Description Here}} - ### [Test-CsAVEdgeConnectivity](Test-CsAVEdgeConnectivity.md) -{{Manually Enter Test-CsAVEdgeConnectivity Description Here}} - ### [Test-CsCertificateConfiguration](Test-CsCertificateConfiguration.md) -{{Manually Enter Test-CsCertificateConfiguration Description Here}} - ### [Test-CsClientAuth](Test-CsClientAuth.md) -{{Manually Enter Test-CsClientAuth Description Here}} - ### [Test-CsClientAuthentication](Test-CsClientAuthentication.md) -{{Manually Enter Test-CsClientAuthentication Description Here}} - ### [Test-CsComputer](Test-CsComputer.md) -{{Manually Enter Test-CsComputer Description Here}} - ### [Test-CsDatabase](Test-CsDatabase.md) -{{Manually Enter Test-CsDatabase Description Here}} - ### [Test-CsDataConference](Test-CsDataConference.md) -{{Manually Enter Test-CsDataConference Description Here}} - ### [Test-CsDialInConferencing](Test-CsDialInConferencing.md) -{{Manually Enter Test-CsDialInConferencing Description Here}} - ### [Test-CsDialPlan](Test-CsDialPlan.md) -{{Manually Enter Test-CsDialPlan Description Here}} - -### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) -{{Manually Enter Test-CsEffectiveTenantDialPlan Description Here}} - ### [Test-CsExStorageConnectivity](Test-CsExStorageConnectivity.md) -{{Manually Enter Test-CsExStorageConnectivity Description Here}} - ### [Test-CsExStorageNotification](Test-CsExStorageNotification.md) -{{Manually Enter Test-CsExStorageNotification Description Here}} - ### [Test-CsExUMConnectivity](Test-CsExUMConnectivity.md) -{{Manually Enter Test-CsExUMConnectivity Description Here}} - ### [Test-CsExUMVoiceMail](Test-CsExUMVoiceMail.md) -{{Manually Enter Test-CsExUMVoiceMail Description Here}} - ### [Test-CsFederatedPartner](Test-CsFederatedPartner.md) -{{Manually Enter Test-CsFederatedPartner Description Here}} - ### [Test-CsGroupExpansion](Test-CsGroupExpansion.md) -{{Manually Enter Test-CsGroupExpansion Description Here}} - ### [Test-CsGroupIM](Test-CsGroupIM.md) -{{Manually Enter Test-CsGroupIM Description Here}} - ### [Test-CsIM](Test-CsIM.md) -{{Manually Enter Test-CsIM Description Here}} - ### [Test-CsInterTrunkRouting](Test-CsInterTrunkRouting.md) -{{Manually Enter Test-CsInterTrunkRouting Description Here}} - ### [Test-CsKerberosAccountAssignment](Test-CsKerberosAccountAssignment.md) -{{Manually Enter Test-CsKerberosAccountAssignment Description Here}} - ### [Test-CsLisCivicAddress](Test-CsLisCivicAddress.md) -{{Manually Enter Test-CsLisCivicAddress Description Here}} - ### [Test-CsLisConfiguration](Test-CsLisConfiguration.md) -{{Manually Enter Test-CsLisConfiguration Description Here}} - ### [Test-CsLocationPolicy](Test-CsLocationPolicy.md) -{{Manually Enter Test-CsLocationPolicy Description Here}} - ### [Test-CsManagementServer](Test-CsManagementServer.md) -{{Manually Enter Test-CsManagementServer Description Here}} - ### [Test-CsMcxConference](Test-CsMcxConference.md) -{{Manually Enter Test-CsMcxConference Description Here}} - ### [Test-CsMcxP2PIM](Test-CsMcxP2PIM.md) -{{Manually Enter Test-CsMcxP2PIM Description Here}} - ### [Test-CsMcxPushNotification](Test-CsMcxPushNotification.md) -{{Manually Enter Test-CsMcxPushNotification Description Here}} - ### [Test-CsOnlineCarrierPortabilityIn](Test-CsOnlineCarrierPortabilityIn.md) -{{Manually Enter Test-CsOnlineCarrierPortabilityIn Description Here}} - ### [Test-CsOnlineLisCivicAddress](Test-CsOnlineLisCivicAddress.md) -{{Manually Enter Test-CsOnlineLisCivicAddress Description Here}} - ### [Test-CsOnlinePortabilityIn](Test-CsOnlinePortabilityIn.md) -{{Manually Enter Test-CsOnlinePortabilityIn Description Here}} - ### [Test-CsOUPermission](Test-CsOUPermission.md) -{{Manually Enter Test-CsOUPermission Description Here}} - ### [Test-CsP2PAV](Test-CsP2PAV.md) -{{Manually Enter Test-CsP2PAV Description Here}} - ### [Test-CsP2PVideoInteropServerSipTrunkAV](Test-CsP2PVideoInteropServerSipTrunkAV.md) -{{Manually Enter Test-CsP2PVideoInteropServerSipTrunkAV Description Here}} - ### [Test-CsPersistentChatMessage](Test-CsPersistentChatMessage.md) -{{Manually Enter Test-CsPersistentChatMessage Description Here}} - ### [Test-CsPhoneBootstrap](Test-CsPhoneBootstrap.md) -{{Manually Enter Test-CsPhoneBootstrap Description Here}} - ### [Test-CsPresence](Test-CsPresence.md) -{{Manually Enter Test-CsPresence Description Here}} - ### [Test-CsPstnOutboundCall](Test-CsPstnOutboundCall.md) -{{Manually Enter Test-CsPstnOutboundCall Description Here}} - ### [Test-CsPstnPeerToPeerCall](Test-CsPstnPeerToPeerCall.md) -{{Manually Enter Test-CsPstnPeerToPeerCall Description Here}} - ### [Test-CsRegistration](Test-CsRegistration.md) -{{Manually Enter Test-CsRegistration Description Here}} - ### [Test-CsReplica](Test-CsReplica.md) -{{Manually Enter Test-CsReplica Description Here}} - ### [Test-CsSetupPermission](Test-CsSetupPermission.md) -{{Manually Enter Test-CsSetupPermission Description Here}} - ### [Test-CsTopology](Test-CsTopology.md) -{{Manually Enter Test-CsTopology Description Here}} - ### [Test-CsTrunkConfiguration](Test-CsTrunkConfiguration.md) -{{Manually Enter Test-CsTrunkConfiguration Description Here}} - ### [Test-CsUcwaConference](Test-CsUcwaConference.md) -{{Manually Enter Test-CsUcwaConference Description Here}} - ### [Test-CsUnifiedContactStore](Test-CsUnifiedContactStore.md) -{{Manually Enter Test-CsUnifiedContactStore Description Here}} - ### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) -{{Manually Enter Test-CsVoiceNormalizationRule Description Here}} - ### [Test-CsVoicePolicy](Test-CsVoicePolicy.md) -{{Manually Enter Test-CsVoicePolicy Description Here}} - ### [Test-CsVoiceRoute](Test-CsVoiceRoute.md) -{{Manually Enter Test-CsVoiceRoute Description Here}} - ### [Test-CsVoiceTestConfiguration](Test-CsVoiceTestConfiguration.md) -{{Manually Enter Test-CsVoiceTestConfiguration Description Here}} - ### [Test-CsVoiceUser](Test-CsVoiceUser.md) -{{Manually Enter Test-CsVoiceUser Description Here}} - ### [Test-CsWatcherNodeConfiguration](Test-CsWatcherNodeConfiguration.md) -{{Manually Enter Test-CsWatcherNodeConfiguration Description Here}} - ### [Test-CsWebApp](Test-CsWebApp.md) -{{Manually Enter Test-CsWebApp Description Here}} - ### [Test-CsWebAppAnonymous](Test-CsWebAppAnonymous.md) -{{Manually Enter Test-CsWebAppAnonymous Description Here}} - ### [Test-CsWebScheduler](Test-CsWebScheduler.md) -{{Manually Enter Test-CsWebScheduler Description Here}} - ### [Test-CsXmppIM](Test-CsXmppIM.md) -{{Manually Enter Test-CsXmppIM Description Here}} - ### [Uninstall-CsDatabase](Uninstall-CsDatabase.md) -{{Manually Enter Uninstall-CsDatabase Description Here}} - ### [Uninstall-CsMirrorDatabase](Uninstall-CsMirrorDatabase.md) -{{Manually Enter Uninstall-CsMirrorDatabase Description Here}} - ### [Unlock-CsClientPin](Unlock-CsClientPin.md) -{{Manually Enter Unlock-CsClientPin Description Here}} - ### [Unpublish-CsLisConfiguration](Unpublish-CsLisConfiguration.md) -{{Manually Enter Unpublish-CsLisConfiguration Description Here}} - -### [Unregister-CsHybridPSTNAppliance](Unregister-CsHybridPSTNAppliance.md) -{{Manually Enter Unregister-CsHybridPSTNAppliance Description Here}} - -### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) -{{Manually Enter Unregister-CsOnlineDialInConferencingServiceNumber Description Here}} - ### [Update-CsAddressBook](Update-CsAddressBook.md) -{{Manually Enter Update-CsAddressBook Description Here}} - ### [Update-CsAdminRole](Update-CsAdminRole.md) -{{Manually Enter Update-CsAdminRole Description Here}} - ### [Update-CsClsLogging](Update-CsClsLogging.md) -{{Manually Enter Update-CsClsLogging Description Here}} - -### [Update-CsOrganizationalAutoAttendant](Update-CsOrganizationalAutoAttendant.md) -{{Manually Enter Update-CsOrganizationalAutoAttendant Description Here}} - -### [Update-CsTenantMeetingUrl](Update-CsTenantMeetingUrl.md) -{{Manually Enter Update-CsTenantMeetingUrl Description Here}} - ### [Update-CsUserData](Update-CsUserData.md) -{{Manually Enter Update-CsUserData Description Here}} - ### [Update-CsUserDatabase](Update-CsUserDatabase.md) -{{Manually Enter Update-CsUserDatabase Description Here}} - -### [Get-CsTeamsInteropPolicy](Get-CsTeamsInteropPolicy.md) -{{Manually Enter Get-CsTeamsInteropPolicy Description Here}} - -### [Grant-CsTeamsInteropPolicy](Grant-CsTeamsInteropPolicy.md) -{{Manually Enter Grant-CsTeamsInteropPolicy Description Here}} - -### [Remove-CsTeamsInteropPolicy](Remove-CsTeamsInteropPolicy.md) -{{Manually Enter Remove-CsTeamsInteropPolicy Description Here}} - -### [Set-CsPlatformServiceSettings](Set-CsPlatformServiceSettings.md) -{{Manually Enter Set-CsPlatformServiceSettings Description Here}} - -### [Get-CsPlatformServiceSettings](Get-CsPlatformServiceSettings.md) -{{Manually Enter Get-CsPlatformServiceSettings Description Here}} - -### [New-CsPlatformServiceSettings](New-CsPlatformServiceSettings.md) -{{Manually Enter New-CsPlatformServiceSettings Description Here}} - -### [Remove-CsPlatformServiceSettings](Remove-CsPlatformServiceSettings.md) -{{Manually Enter Remove-CsPlatformServiceSettings Description Here}} - -### [Get-CsAdditionalInternalDomain](Get-CsAdditionalInternalDomain.md) -{{Manually Enter Get-CsAdditionalInternalDomain Description Here}} - -### [New-CsAdditionalInternalDomain](New-CsAdditionalInternalDomain.md) -{{Manually Enter New-CsAdditionalInternalDomain Description Here}} - -### [Remove-CsAdditionalInternalDomain](Remove-CsAdditionalInternalDomain.md) -{{Manually Enter Remove-CsAdditionalInternalDomain Description Here}} - -### [Get-CsHybridApplicationEndpoint](Get-CsHybridApplicationEndpoint.md) -{{Manually Enter Get-CsHybridApplicationEndpoint Description Here}} - -### [New-CsHybridApplicationEndpoint](New-CsHybridApplicationEndpoint.md) -{{Manually Enter New-CsHybridApplicationEndpoint Description Here}} - -### [Set-CsHybridApplicationEndpoint](Set-CsHybridApplicationEndpoint.md) -{{Manually Enter Set-CsHybridApplicationEndpoint Description Here}} - -### [Remove-CsHybridApplicationEndpoint](Remove-CsHybridApplicationEndpoint.md) -{{Manually Enter Remove-CsHybridApplicationEndpoint Description Here}} - -### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) - -### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) - -### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) - -### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) - -### [New-CsTeamsUpgradePolicy](New-CsTeamsUpgradePolicy.md) - -### [Remove-CsTeamsUpgradePolicy](Remove-CsTeamsUpgradePolicy.md) - -### [Set-CsTeamsUpgradePolicy](Set-CsTeamsUpgradePolicy.md) - -### [Get-CsCloudCallDataConnector](Get-CsCloudCallDataConnector.md) - -### [Get-CsCloudCallDataConnectorConfiguration](Get-CsCloudCallDataConnectorConfiguration.md) - -### [New-CsCloudCallDataConnectorConfiguration](New-CsCloudCallDataConnectorConfiguration.md) - -### [Set-CsCloudCallDataConnector](Set-CsCloudCallDataConnector.md) - -### [Set-CsCloudCallDataConnectorConfiguration](Set-CsCloudCallDataConnectorConfiguration.md) - -### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) - -### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) - -### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) - -### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) - -### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) - -### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) - -### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) - -### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) - -### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) - -### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) - -### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) - -### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) - -### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) - -### [Set-CsAuthConfig](Set-CsAuthConfig.md) - -### [Get-CsAuthConfig](Get-CsAuthConfig.md) - -### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) - -### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) - -### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) - -### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) - -### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) - -### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) - -### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) - -### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) - -### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) - -### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) - -### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) - -### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) - -### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) - -### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) - -### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) - -### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) - -### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) - -### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) - -### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) - -### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) - -### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) - -### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) - -### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) - -### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) - -### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) - -### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) - -### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) - -### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) - -### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) - -### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) - -### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) - -### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) - -### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) - -### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) - -### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) - -### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) - -### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) - -### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) - -### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) - -### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) - -### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) - -### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) - -### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) - -### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) - -### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) - -### [Get-CsTeamsUpgradeStatus](Get-CsTeamsUpgradeStatus.md) -{{Manually Enter Get-CsTeamsUpgradeStatus Description Here}} - -### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRuley.md) - -### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRuley.md) - -### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRuley.md) - -### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRuley.md) - -### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) - -### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) - -### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) - -### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) - -### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) - -### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) - -### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) - -### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) - -### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) - -### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) - -### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) - -### [Get-CSTeamsIPPhonePolicy](Get-CSTeamsIPPhonePolicy.md) - -### [Grant-CSTeamsIPPhonePolicy](Grant-CSTeamsIPPhonePolicy.md) - -### [New-CSTeamsIPPhonePolicy](New-CSTeamsIPPhonePolicy.md) - -### [Remove-CSTeamsIPPhonePolicy](Remove-CSTeamsIPPhonePolicy.md) - -### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) diff --git a/spmt/docfx.json b/spmt/docfx.json index 17f1039eb9..44cc42e8b1 100644 --- a/spmt/docfx.json +++ b/spmt/docfx.json @@ -27,7 +27,11 @@ }, { "files": [ - "**/*.md" + "**/*.yml", + "**/spmt.md" + ], + "exclude": [ + "toc.yml" ], "src": "spmt-ps", "version": "spmt-ps", @@ -62,6 +66,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "serdarsoysal", "ms.author": "serdars", "manager": "serdars", @@ -72,9 +77,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": {}, "template": [], diff --git a/spmt/docs-conceptual/index.md b/spmt/docs-conceptual/index.md index 6727a5cd65..520cbb77ca 100644 --- a/spmt/docs-conceptual/index.md +++ b/spmt/docs-conceptual/index.md @@ -1,6 +1,7 @@ --- ms.localizationpriority: medium title: Microsoft SharePoint Migration Tool cmdlet help reference +ms.date: 01/01/2020 description: "Learn about the Microsoft SharePoint Migration Tool PowerShell cmdlet help reference." --- diff --git a/spmt/docs-conceptual/intro.md b/spmt/docs-conceptual/intro.md index 540518e7dc..7d2f08a7ba 100644 --- a/spmt/docs-conceptual/intro.md +++ b/spmt/docs-conceptual/intro.md @@ -1,6 +1,7 @@ --- ms.localizationpriority: medium title: Microsoft SharePoint Migration Tool cmdlet reference +ms.date: 01/01/2020 description: "Learn about Microsoft SharePoint Migration Tool cmdlets." --- @@ -12,4 +13,4 @@ Here you will find all of the Microsoft SharePoint Migration Tool PowerShell hel The repo is located here: and you can find the README displayed at the bottom of the page. -To find other modules you can use the PowerShell Module Browser located at: `https://docs.microsoft.com/powershell/module`. For example, to see the SharePoint modules you could use this query: `https://docs.microsoft.com/powershell/module/?term=sharepoint`. +To find other modules you can use the PowerShell Module Browser located at: `https://learn.microsoft.com/powershell/module`. For example, to see the SharePoint modules you could use this query: `https://learn.microsoft.com/powershell/module/?term=sharepoint`. diff --git a/spmt/docs-conceptual/overview.md b/spmt/docs-conceptual/overview.md index c6ba9ea695..d9f557df03 100644 --- a/spmt/docs-conceptual/overview.md +++ b/spmt/docs-conceptual/overview.md @@ -1,5 +1,7 @@ --- title: My overview +ms.date: 01/01/2020 +description: "Microsoft SharePoint Migration Tool cmdlet reference." --- # My overview diff --git a/spmt/mapping/monikerMapping.json b/spmt/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from spmt/mapping/monikerMapping.json rename to spmt/mapping/MAML2Yaml/monikerMapping.json diff --git a/spmt/spmt-ps/spmt/Add-SPMTTask.md b/spmt/spmt-ps/spmt/Add-SPMTTask.md index 083e26be21..eb66f4701b 100644 --- a/spmt/spmt-ps/spmt/Add-SPMTTask.md +++ b/spmt/spmt-ps/spmt/Add-SPMTTask.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/add-spmttask +online version: https://learn.microsoft.com/powershell/module/spmt/add-spmttask applicable: SharePoint Migration Tool title: Add-SPMTTask schema: 2.0.0 diff --git a/spmt/spmt-ps/spmt/Get-SPMTMigration.md b/spmt/spmt-ps/spmt/Get-SPMTMigration.md index afdcacd7b1..1e4b20d6a6 100644 --- a/spmt/spmt-ps/spmt/Get-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Get-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/get-spmtmigration +online version: https://learn.microsoft.com/powershell/module/spmt/get-spmtmigration applicable: SharePoint Migration Tool title: Get-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/spmt/Register-SPMTMigration.md b/spmt/spmt-ps/spmt/Register-SPMTMigration.md index e306f08e87..f092abf2ef 100644 --- a/spmt/spmt-ps/spmt/Register-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Register-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/register-spmtmigration +online version: https://learn.microsoft.com/powershell/module/spmt/register-spmtmigration applicable: SharePoint Migration Tool title: Register-SPMTMigration schema: 2.0.0 @@ -19,7 +19,7 @@ After a session is registered, the user can add a migration task to the migratio ## SYNTAX ```powershell -Register-SPMTMigration [-SPOCredentials] [-EnableMultiRound ] [-ScanOnly ] [-MigrateFilesAndFoldersWithInvalidChars ] [-AzureActiveDirectoryLookup ] [-CustomAzureAccessKey ] [-CustomAzureStorageAccount ] [-DeleteTempFilesWhenMigrationDone ] [-EnableEncryption ] [-IgnoreUpdate ] [-KeepAllVersions ] [-MigrateFileVersionHistory ] [-MigrateOneNoteFolderAsOneNoteNoteBook ] [-MigrateFilesCreatedAfter ] [-MigrateFilesModifiedAfter ] [-SkipFilesWithExtension ] [-IncludeHiddenFiles ] [-NumberOfVersionToMigrate ] [-PreserveUserPermissionsForFileShare ] [-PreserveUserPermissionsForSharePointSource ] [-SkipListWithAudienceTargetingEnabled ] [-StartMigrationAutomaticallyWhenNoScanIssue ] [-UseCustomAzureStorage ] [-UserMappingFile ] [-MigrateAllSiteFieldsAndContentTypes] [-WorkingFolder ] [-SkipSitesWithName ] [-SkipListsWithName ] [-SkipContentTypesWithName ] [-DuplicatePageBehavior ] [-MigrateNavigation ] [-MigrateTermGroups ] [-MigrateWithoutRootFolder] -Force +Register-SPMTMigration [-SPOCredentials] [-EnableMultiRound ] [-ScanOnly ] [-AzureActiveDirectoryLookup ] [-CustomAzureAccessKey ] [-CustomAzureStorageAccount ] [-DeleteTempFilesWhenMigrationDone ] [-EnableEncryption ] [-IgnoreUpdate ] [-KeepAllVersions ] [-MigrateFileVersionHistory ] [-MigrateOneNoteFolderAsOneNoteNoteBook ] [-MigrateFilesCreatedAfter ] [-MigrateFilesModifiedAfter ] [-SkipFilesWithExtension ] [-IncludeHiddenFiles ] [-NumberOfVersionToMigrate ] [-PreserveUserPermissionsForFileShare ] [-PreserveUserPermissionsForSharePointSource ] [-SkipListWithAudienceTargetingEnabled ] [-StartMigrationAutomaticallyWhenNoScanIssue ] [-UseCustomAzureStorage ] [-UserMappingFile ] [-MigrateAllSiteFieldsAndContentTypes] [-WorkingFolder ] [-SkipSitesWithName ] [-SkipListsWithName ] [-SkipContentTypesWithName ] [-DuplicatePageBehavior ] [-MigrateNavigation ] [-MigrateTermGroups ] [-MigrateWithoutRootFolder] -Force ``` ## DESCRIPTION @@ -49,7 +49,7 @@ This example registers a migration session. ### -AzureActiveDirectoryLookup By default, this is set to On. -If no user mapping file is provided by the user, then Azure Active Directory is used as the default for user mapping. +If no user mapping file is provided by the user, then Microsoft Entra ID is used as the default for user mapping. ```yaml Type: Boolean @@ -219,23 +219,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateFilesAndFoldersWithInvalidChars -The default is On. -Files and folders with invalid characters (for example:\<, \>, :, ", |, ?, *, /, \,\u007f) in the names will be migrated by default. -If set to Off, files and folders with invalid characters in names will not be migrated. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -MigrateFilesCreatedAfter If you choose to limit which files are to be migrated based on creation dates, set your values in this section. This may be to limit the number of files migrated or to adhere to overall company governance policy regarding to file retention. @@ -449,8 +432,8 @@ Accept wildcard characters: False ``` ### -UserMappingFile -By default, Azure AD lookup is used to map users when submitting migration jobs. -If you choose to use a custom user mapping file and you want to preserve user permissions, turn off Azure Active Directory lookup.By doing so, if a user isn't found in the mapping file, the tool won't look it up in AAD. +By default, Microsoft Entra lookup is used to map users when submitting migration jobs. +If you choose to use a custom user mapping file and you want to preserve user permissions, turn off Microsoft Entra lookup.By doing so, if a user isn't found in the mapping file, the tool won't look it up in Microsoft Entra ID. ```yaml Type: String diff --git a/spmt/spmt-ps/spmt/Remove-SPMTTask.md b/spmt/spmt-ps/spmt/Remove-SPMTTask.md index 46dd64e320..a8c0c3f424 100644 --- a/spmt/spmt-ps/spmt/Remove-SPMTTask.md +++ b/spmt/spmt-ps/spmt/Remove-SPMTTask.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/remove-spmttask +online version: https://learn.microsoft.com/powershell/module/spmt/remove-spmttask applicable: SharePoint Migration Tool title: Remove-SPMTTask schema: 2.0.0 diff --git a/spmt/spmt-ps/spmt/spmt.md b/spmt/spmt-ps/spmt/SharePointMigrationTool.md similarity index 100% rename from spmt/spmt-ps/spmt/spmt.md rename to spmt/spmt-ps/spmt/SharePointMigrationTool.md diff --git a/spmt/spmt-ps/spmt/Show-SPMTMigration.md b/spmt/spmt-ps/spmt/Show-SPMTMigration.md index 145de82247..5d9ded7974 100644 --- a/spmt/spmt-ps/spmt/Show-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Show-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/show-spmtmigration +online version: https://learn.microsoft.com/powershell/module/spmt/show-spmtmigration applicable: SharePoint Migration Tool title: Show-SPMTMigration schema: 2.0.0 @@ -13,7 +13,7 @@ ms.reviewer: # Show-SPMTMigration ## SYNOPSIS -If the user starts the migration with -NoShow parameter, running the ‘Show-SPMTMigration’ cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. +If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. ## SYNTAX @@ -22,7 +22,7 @@ Show-SPMTMigration [] ``` ## DESCRIPTION -If the user starts the migration with -NoShow parameter, running the ‘Show-SPMTMigration’ cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. +If the user starts the migration with -NoShow parameter, running the 'Show-SPMTMigration' cmdlet will display the task ID, data source location, target location and migration status in the console. Pressing Ctrl+C will return to NoShow mode. ## EXAMPLES @@ -62,7 +62,7 @@ Start-SPMTMigration -NoShow Show-SPMTMigration ``` -This example, first, starts a migration with -NoShow parameter, then run ‘Show-SPMTMigration’, the migration task ID, data source location, target location and migration status will show up in the console. +This example, first, starts a migration with -NoShow parameter, then run 'Show-SPMTMigration', the migration task ID, data source location, target location and migration status will show up in the console. ## PARAMETERS diff --git a/spmt/spmt-ps/spmt/Start-SPMTMigration.md b/spmt/spmt-ps/spmt/Start-SPMTMigration.md index bb0bf14f37..285f7f17c9 100644 --- a/spmt/spmt-ps/spmt/Start-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Start-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/start-spmtmigration +online version: https://learn.microsoft.com/powershell/module/spmt/start-spmtmigration applicable: SharePoint Migration Tool title: Start-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/spmt/Stop-SPMTMigration.md b/spmt/spmt-ps/spmt/Stop-SPMTMigration.md index 8962dc7f90..211d84a4ec 100644 --- a/spmt/spmt-ps/spmt/Stop-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Stop-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/stop-spmtmigration +online version: https://learn.microsoft.com/powershell/module/spmt/stop-spmtmigration applicable: SharePoint Migration Tool title: Stop-SPMTMigration schema: 2.0.0 diff --git a/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md b/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md index 41eac4a0a5..173a2fee3e 100644 --- a/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Unregister-SPMTMigration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.SharePoint.MigrationTool.PowerShell.dll-Help.xml Module Name: Microsoft.SharePoint.MigrationTool.PowerShell -online version: https://docs.microsoft.com/powershell/module/spmt/unregister-spmtmigration +online version: https://learn.microsoft.com/powershell/module/spmt/unregister-spmtmigration applicable: SharePoint Migration Tool title: Unregister-SPMTMigration schema: 2.0.0 diff --git a/staffhub/docfx.json b/staffhub/docfx.json deleted file mode 100644 index d92820470a..0000000000 --- a/staffhub/docfx.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "build": { - "content": [ - { - "files": ["**/*.md"], - "src": "docs-conceptual", - "version": "staffhub-ps", - "dest": "staffhub", - "exclude": [ - "**/obj/**", - "**/includes/**", - "README.md", - "LICENSE", - "LICENSE-CODE", - "ThirdPartyNotices"] - }, - { - "files": ["toc.yml"], - "src": "docs-conceptual", - "version": "staffhub-ps", - "dest": "staffhub/staffhub-ps" - }, - { - "files": ["**/*.yml"], - "exclude": ["toc.yml"], - "src": "staffhub-ps", - "version": "staffhub-ps", - "dest": "module" - }, - { - "files": ["toc.yml"], - "src": "staffhub-ps", - "version": "staffhub-ps", - "dest": "module/staffhub-ps" - } - ], - "resource": [ - { - "files": [ - "**/*.png", - "**/*.jpg" - ], - "exclude": [ - "**/obj/**", - "**/includes/**" - ] - } - ], - "versions": { - "staffhub-ps": { - "dest": "staffhub-ps" - } - }, - "overwrite": [], - "externalReference": [], - "globalMetadata": { - "author" : "serdarsoysal", - "ms.author" : "serdars", - "manager" : "serdars", - "ms.date" : "09/25/2017", - "ms.topic" : "reference", - "ms.service" : "staffhub-powershell", - "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": {}, - "template": [], - "dest": "staffhub-ps" - } -} diff --git a/staffhub/docs-conceptual/LICENSE.txt b/staffhub/docs-conceptual/LICENSE.txt deleted file mode 100644 index 26d50e3e0f..0000000000 --- a/staffhub/docs-conceptual/LICENSE.txt +++ /dev/null @@ -1,190 +0,0 @@ -------------------------------------------- START OF LICENSE ----------------------------------------- - -Microsoft StaffHub PowerShell Cmdlets - -Copyright (c) Microsoft Corporation. All rights reserved. - -MIT License - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT -LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF -CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------------------------------------------ END OF LICENSE ------------------------------------------ - -THIRD PARTY SOFTWARE NOTICES -Do Not Translate or Localize - -This file is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Microsoft product. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise. -1. azure-sdk-for-net (Microsoft.Rest.ClientRuntime) #f5b4bee10d8a0264e5cd810e7ec1829209cda6b8 -2. azure-sdk-for-net (Microsoft.Rest.ClientRuntime.Azure) #f5b4bee10d8a0264e5cd810e7ec1829209cda6b8 -3. Json.NET v10.0.3 -4. azure-activedirectory-library-for-dotnet v3.17.0 - -START OF NOTICES AND INFORMATION for azure-sdk-for-net (Microsoft.Rest.ClientRuntime) #f5b4bee10d8a0264e5cd810e7ec1829209cda6b8 -========================================= -Copyright (c) 2015 Microsoft -https://github.com/Azure/azure-sdk-for-net/#readme --------------------------------------START OF LICENSE ------------------------------------------------------------ -MIT License -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ - -/azure-sdk-for-net-f5b4bee10d8a0264e5cd810e7ec1829209cda6b8/tools/AzCopy/Newtonsoft.Json.dll -Copyright (c) 2007 James Newton-King -https://github.com/JamesNK/Newtonsoft.Json --------------------------------------START OF LICENSE ------------------------------------------------------------ -The MIT License (MIT) -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ -========================================= -END OF NOTICES AND INFORMATION for azure-sdk-for-net (Microsoft.Rest.ClientRuntime) #f5b4bee10d8a0264e5cd810e7ec1829209cda6b8 - -START OF NOTICES AND INFORMATION for azure-sdk-for-net (Microsoft.Rest.ClientRuntime.Azure) #f5b4bee10d8a0264e5cd810e7ec1829209cda6b8 -========================================= -Copyright (c) 2015 Microsoft -https://github.com/Azure/azure-sdk-for-net/#readme --------------------------------------START OF LICENSE ------------------------------------------------------------ -MIT License - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ - -/azure-sdk-for-net-f5b4bee10d8a0264e5cd810e7ec1829209cda6b8/tools/AzCopy/Newtonsoft.Json.dll -Copyright (c) 2007 James Newton-King -https://github.com/JamesNK/Newtonsoft.Json -------------------------------------START OF LICENSE ------------------------------------------------------------ -The MIT License (MIT) -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ -========================================= -END OF NOTICES AND INFORMATION for azure-sdk-for-net (Microsoft.Rest.ClientRuntime.Azure) #f5b4bee10d8a0264e5cd810e7ec1829209cda6b8 - - -START OF NOTICES AND INFORMATION for Json.NET v10.0.3 -========================================= -Copyright (c) 2007 James Newton-King -https://github.com/JamesNK/Newtonsoft.Json --------------------------------------START OF LICENSE ------------------------------------------------------------ -MIT License - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ - -/Newtonsoft.Json-10.0.3/Src/Newtonsoft.Json/Utilities/LinqBridge.cs -LINQBridge Copyright (c) 2007-2009, Atif Aziz, Joseph Albahari -All rights reserved. --------------------------------------START OF LICENSE ------------------------------------------------------------ -BSD – 3 License -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -- Neither the name of the original authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ - -/Newtonsoft.Json-10.0.3/Src/Newtonsoft.Json/Utilities/ConvertUtils.cs -Copyright (c) .NET Foundation and Contributors -All rights reserved. -https://github.com/dotnet/coreclr/blob/master/src/classlibnative/bcltype/number.cpp#L451 --------------------------------------START OF LICENSE ------------------------------------------------------------ -The MIT License (MIT) -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ -========================================= -END OF NOTICES AND INFORMATION for Json.NET v10.0.3 - -START OF NOTICES AND INFORMATION for azure-activedirectory-library-for-dotnet v3.17.0 -========================================= -Copyright (c) Microsoft -https://github.com/AzureAD/azure-activedirectory-library-for-dotnet#readme --------------------------------------START OF LICENSE ------------------------------------------------------------ -MIT License -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -----------------------------------------END OF LICENSE ------------------------------------------------------------ -========================================= -END OF NOTICES AND INFORMATION for azure-activedirectory-library-for-dotnet v3.17.0 diff --git a/staffhub/mapping/monikerMapping.json b/staffhub/mapping/monikerMapping.json deleted file mode 100644 index 5f53e202ea..0000000000 --- a/staffhub/mapping/monikerMapping.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "staffhub-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/staffhub/staffhub-ps/toc.json", - "referenceTocUrl": "/powershell/module/staffhub-ps/toc.json", - "packageRoot": "staffhub-ps", - "modules": { - "staffhub": {} - } - } -} diff --git a/teams/docfx.json b/teams/docfx.json index 221743c121..401d0beb8b 100644 --- a/teams/docfx.json +++ b/teams/docfx.json @@ -54,6 +54,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-MicrosoftTeams", "author" : "serdarsoysal", "ms.author" : "serdars", "manager" : "serdars", @@ -64,9 +65,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": {}, "template": [], diff --git a/teams/docs-conceptual/index.md b/teams/docs-conceptual/index.md index f3970a67bd..83c900e736 100644 --- a/teams/docs-conceptual/index.md +++ b/teams/docs-conceptual/index.md @@ -1,6 +1,7 @@ --- ms.localizationpriority: medium title: Microsoft Teams cmdlet help reference +ms.date: 01/01/2020 description: "Learn about the Microsoft Teams PowerShell cmdlet help reference." --- @@ -8,7 +9,7 @@ description: "Learn about the Microsoft Teams PowerShell cmdlet help reference." Welcome to the Microsoft Teams PowerShell cmdlet **Help** reference. -This PowerShell module is used for provisioning and management of teams and their backing groups themselves. The module can be installed here: . To manage the policies and configurations that apply to the Microsoft Teams service, please see the reference documents for the Skype for Business module: `https://docs.microsoft.com/powershell/module/skype`. Skype for Business Online cmdlets are now integrated into the Teams PowerShell module. +This PowerShell module is used for provisioning and management of teams and their backing groups themselves. The module can be installed here: . Here, you will find all of the Microsoft Teams PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. diff --git a/teams/docs-conceptual/intro.md b/teams/docs-conceptual/intro.md deleted file mode 100644 index 9386c4f7ac..0000000000 --- a/teams/docs-conceptual/intro.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ms.localizationpriority: medium -title: Microsoft Teams cmdlet reference -description: "Learn about Microsoft Teams cmdlets." ---- - -# Microsoft Teams cmdlet reference - -Welcome to the Microsoft Teams PowerShell cmdlet help references. Cmdlets for managing Microsoft Teams service are split between two powershell modules: the Skype for Business Online module and the Microsoft Teams module. - -This powershell module is used for provisioning and management of teams and their backing groups themselves. The module can be installed here: . To manage the policies and configurations that apply to the Microsoft Teams service, please see the reference docs for the Skype for Business module: `https://docs.microsoft.com/powershell/module/skype/?view=skype-ps`. - -Here you will find all of the Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. - -The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/teams/docs-conceptual/overview.md b/teams/docs-conceptual/overview.md index c6ba9ea695..e4b420d32e 100644 --- a/teams/docs-conceptual/overview.md +++ b/teams/docs-conceptual/overview.md @@ -1,5 +1,7 @@ --- title: My overview +ms.date: 01/01/2020 +description: "Microsoft Teams cmdlet help reference." --- # My overview diff --git a/teams/docs-conceptual/toc.yml b/teams/docs-conceptual/toc.yml index 2f726b4da1..1ba183cc0b 100644 --- a/teams/docs-conceptual/toc.yml +++ b/teams/docs-conceptual/toc.yml @@ -1,5 +1,2 @@ - name: Overview href: index.md - items: - - name: Introduction - href: intro.md diff --git a/teams/mapping/monikerMapping.json b/teams/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from teams/mapping/monikerMapping.json rename to teams/mapping/MAML2Yaml/monikerMapping.json diff --git a/teams/teams-ps/Remove-CsOnlineTelephoneNumber.md b/teams/teams-ps/Remove-CsOnlineTelephoneNumber.md deleted file mode 100644 index 8bd496af5b..0000000000 --- a/teams/teams-ps/Remove-CsOnlineTelephoneNumber.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber -Module Name: MicrosoftTeams -title: Remove-CsOnlineTelephoneNumber -schema: 2.0.0 -manager: mreddy -author: TristanChen-msft -ms.author: jiaych -ms.reviewer: julienp ---- - -# Remove-CsOnlineTelephoneNumber - -## SYNOPSIS -Use the `Remove-CsOnlineTelephoneNumber` cmdlet to remove one or more unassigned telephone numbers from your tenant. - -## SYNTAX - -``` -Remove-CsOnlineTelephoneNumber -TelephoneNumber [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removes one or more unassigned telephone numbers from your tenant. Invalid telephone numbers will be reported while valid telephone numbers will be removed from your tenant. - -### -------------------------- Example 1 -------------------------- -``` -Remove-CsOnlineTelephoneNumber -TelephoneNumber 14258884567 -``` -```Output -NumberIdsDeleted NumberIdsAssigned NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk ----------------- ----------------- --------------------- ------------------------- ----------------------------- -{14258884567} {} {} {} -``` - -This example removes the specified unassigned telephone number from the tenant. - -### -------------------------- Example 2 -------------------------- -``` -[string[]]$tns="+14255551234","+14255551233" -Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns -``` -```Output -NumberIdsDeleted NumberIdsAssigned NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk ----------------- ----------------- --------------------- ------------------------- ----------------------------- -{14255551234, {} {} {} - 14255551233} -``` - -This example removes the specified list of unassigned telephone numbers from the tenant. - - -### -------------------------- Example 3 -------------------------- -``` -[string[]]$tns="+14255551234","+14255551233", "+14255550000", "+14255551111", "+14255552222" -Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns -``` -```Output -NumberIdsDeleted NumberIdsAssigned NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk ----------------- ----------------- --------------------- ------------------------- ----------------------------- -{14255551234, {14255550000} {} {14255551111} {14255552222} - 14255551233} -``` - -This example removes the specified list of telephone numbers from the tenant. `+14255551234` and `+14255551233`were removed successfully. `+14255550000` failed to be removed because it was still assigned. `+14255551111` failed to be removed because it didn't belong to the tenant. `+14255552222` failed to be removed because it was managed by service desk. - -## PARAMETERS - -### -TelephoneNumber -Specifies the telephone number(s) to remove. The format can be withor without the prefixed +, but needs to include country code etc. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online, Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. -By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online, Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -### -None - -## NOTES -Invalid telephone numbers will be reported while valid telephone numbers will be removed from your tenant. - -## RELATED LINKS -[Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) diff --git a/teams/teams-ps/teams/Add-TeamChannelUser.md b/teams/teams-ps/teams/Add-TeamChannelUser.md index 8a3eff1fa7..dcc55539d1 100644 --- a/teams/teams-ps/teams/Add-TeamChannelUser.md +++ b/teams/teams-ps/teams/Add-TeamChannelUser.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/add-teamchanneluser +online version: https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser +title: Add-TeamChannelUser schema: 2.0.0 --- @@ -10,20 +11,19 @@ schema: 2.0.0 ## SYNOPSIS Adds an owner or member to the private channel. -Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. +The command will return immediately, but the Teams application will not reflect the update immediately. To see the update you should refresh the members page. -To turn an existing Member into an Owner, first Add-TeamChannelUser -User foo to add them to the members list, then Add-TeamChannelUser -User foo -Role Owner to add them to owner list. +Note: Technical limitations of private channels apply. To add a user as a member to a channel, they need to first be a member of the team. To make a user an owner of a channel, they need to first be a member of the channel. ## SYNTAX ``` -Add-TeamChannelUser -GroupId -DisplayName -User [-Role ] - [] +Add-TeamChannelUser -GroupId -DisplayName -User [-Role ] [-TenantId ] [] ``` ## DESCRIPTION -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://docs.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://docs.microsoft.com/microsoftteams/teams-powershell-release-notes). +Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -41,6 +41,13 @@ Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName " Promote user dmx@example.com to an owner of private channel with name "Engineering" under the given group. +### Example 3 +``` +Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User 0e4249a7-6cfd-8c93-a510-91cda44c8c73 -TenantId dcd143cb-c4ae-4364-9faf-e1c3242bf4ff +``` + +Adds external user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 to a shared channel. + ## PARAMETERS ### -GroupId @@ -104,12 +111,28 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -TenantId +TenantId of the external user + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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/?LinkID=113216). ## INPUTS -### GroupId, DisplayName, User, Role +### GroupId, DisplayName, User, Role, TenantId + ## OUTPUTS ## NOTES diff --git a/teams/teams-ps/teams/Add-TeamUser.md b/teams/teams-ps/teams/Add-TeamUser.md index de6dab24f2..91f29ce8bb 100644 --- a/teams/teams-ps/teams/Add-TeamUser.md +++ b/teams/teams-ps/teams/Add-TeamUser.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/add-teamuser +online version: https://learn.microsoft.com/powershell/module/teams/add-teamuser +title: Add-TeamUser schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -22,7 +23,7 @@ Add-TeamUser -GroupId -User [-Role ] [ [!Note] -> The command will return immediately, but the Teams application will not reflect the update immediately. The change can take between 24 and 48 hours to appear within the Teams client. +> The command will return immediately, but the Teams application will not reflect the update immediately. The change can take between 24 and 48 hours to appear within the Teams client. ## EXAMPLES @@ -66,7 +67,7 @@ Accept wildcard characters: False ``` ### -Role -Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. +Member or Owner. If Owner is specified then the user is also added as a member to the Team backed by unified group. ```yaml Type: String @@ -81,8 +82,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Add-TeamsAppInstallation.md b/teams/teams-ps/teams/Add-TeamsAppInstallation.md index 764f885843..031a1aa094 100644 --- a/teams/teams-ps/teams/Add-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Add-TeamsAppInstallation.md @@ -1,11 +1,9 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/add-teamsappinstallation +online version: https://learn.microsoft.com/powershell/module/teams/add-teamsappinstallation +title: Add-TeamsAppInstallation schema: 2.0.0 -author: serdarsoysal -ms.author: serdars -ms.reviewer: --- # Add-TeamsAppInstallation @@ -28,7 +26,7 @@ Add-TeamsAppInstallation -AppId -UserId [-Permissions ## DESCRIPTION Add a Teams App to Microsoft Teams. -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://docs.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://docs.microsoft.com/microsoftteams/teams-powershell-release-notes). +Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -118,6 +116,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md index 18a78efe7a..36eee8cbf2 100644 --- a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder +online version: https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder Module Name: MicrosoftTeams title: Clear-CsOnlineTelephoneNumberOrder schema: 2.0.0 @@ -59,8 +59,7 @@ Location TelephoneNumber New York City +17182000004 ``` -This example cancels the purchase of the telephone number order containing the phone number +17182000004. - +This example cancels the purchase of the telephone number order containing the phone number +17182000004. ## PARAMETERS @@ -70,7 +69,7 @@ Specifies the telephone number search order to look up. Use `New-CsOnlineTelepho ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -79,16 +78,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) + +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) + +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) + +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) + +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) -[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) \ No newline at end of file +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md new file mode 100644 index 0000000000..62e51c733c --- /dev/null +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -0,0 +1,53 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig +title: Clear-TeamsEnvironmentConfig +schema: 2.0.0 +author: VikneshMSFT +ms.author: vimohan +ms.reviewer: pbafna +manager: vinelap +--- + +# Clear-TeamsEnvironmentConfig + +## SYNOPSIS +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +## SYNTAX + +``` +Clear-TeamsEnvironmentConfig [] +``` + +## DESCRIPTION +This cmdlet clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. This helps in clearing and rectifying any wrong information set in Set-TeamsEnvironmentConfig. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Clear-TeamsEnvironmentConfig +``` + +Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. + +## 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 + +We do not recommend using Clear-TeamsEnvironmentConfig in Commercial, GCC, GCC High, or DoD environments. This cmdlet is available in Microsoft Teams PowerShell module from version 5.2.0-GA. + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md index 035a5992d3..8e367470c6 100644 --- a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder +online version: https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder Module Name: MicrosoftTeams title: Complete-CsOnlineTelephoneNumberOrder schema: 2.0.0 @@ -26,7 +26,6 @@ Complete-CsOnlineTelephoneNumberOrder [-OrderId] [] Use the `Complete-CsOnlineTelephoneNumberOrder` cmdlet to complete a specific telephone number search order and confirm the purchase of the new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -60,8 +59,7 @@ Location TelephoneNumber New York City +17182000004 ``` -This example completes the purchase of the telephone number order containing the phone number +17182000004. - +This example completes the purchase of the telephone number order containing the phone number +17182000004. ## PARAMETERS @@ -71,7 +69,7 @@ Specifies the telephone number search order to look up. Use `New-CsOnlineTelepho ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -80,20 +78,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) -[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) -[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) -[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Connect-MicrosoftTeams.md b/teams/teams-ps/teams/Connect-MicrosoftTeams.md index e0ca8c6466..c713e2275a 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Connect-MicrosoftTeams.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/connect-microsoftteams +online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams +title: Connect-MicrosoftTeams schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -17,35 +18,61 @@ The Connect-MicrosoftTeams cmdlet connects an authenticated account for use with ### UserCredential (Default) ``` -Connect-MicrosoftTeams -[-TenantId ] -[-Credential ] +Connect-MicrosoftTeams +[-TenantId ] +[-Credential ] [-AccountId ] -[-LogLevel ] -[-LogFilePath ] -[-TeamsEnvironmentName ] -[-WhatIf] +[-LogLevel ] +[-LogFilePath ] +[-TeamsEnvironmentName ] +[-UseDeviceAuthentication] +[-WhatIf] +[-Confirm] +[] +``` + +### ServicePrincipalCertificate +``` +Connect-MicrosoftTeams +-TenantId +-Certificate +-ApplicationId +[-LogLevel ] +[-LogFilePath ] +[-WhatIf] +[-Confirm] +[] +``` + +### ServicePrincipalCertificateThumbprint +``` +Connect-MicrosoftTeams +-TenantId +-CertificateThumbprint +-ApplicationId +[-LogLevel ] +[-LogFilePath ] +[-WhatIf] [-Confirm] [] ``` ### AccessTokens ``` -Connect-MicrosoftTeams -[-TenantId ] --AccessTokens -[-LogLevel ] -[-LogFilePath ] -[-WhatIf] -[-Confirm] +Connect-MicrosoftTeams +[-TenantId ] +-AccessTokens +[-LogLevel ] +[-LogFilePath ] +[-WhatIf] +[-Confirm] [] ``` ## DESCRIPTION The Connect-MicrosoftTeams cmdlet connects to Microsoft Teams with an authenticated account for use with cmdlets from the MicrosoftTeams PowerShell module. After executing this cmdlet, you can disconnect from MicrosoftTeams account using Disconnect-MicrosoftTeams. -> [!WARNING] ->If basic authentication is not enabled, legacy *-Cs cmdlets will not function properly. For Remote PowerShell, basic authentication is necessary. +**Note**: With versions 4.x.x or later, enablement of basic authentication is not needed anymore in commercial, GCC, GCC High, and DoD environments. ## EXAMPLES @@ -54,7 +81,7 @@ This example connects to an Azure account. You must provide a Microsoft account ```powershell Connect-MicrosoftTeams -Account Environment Tenant TenantId +Account Environment Tenant TenantId ------- ----------- ------------------------------------ ------------------------------------ user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` @@ -65,7 +92,7 @@ The first command prompts for user credentials and stores them in the $Credentia ```powershell $credential = Get-Credential Connect-MicrosoftTeams -Credential $credential -Account Environment Tenant TenantId +Account Environment Tenant TenantId ------- ----------- ------------------------------------ ------------------------------------ user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` @@ -75,13 +102,59 @@ This example connects to an Azure account in a specific environment. You must pr ```powershell Connect-MicrosoftTeams -TeamsEnvironmentName TeamsGCCH -Account Environment Tenant TenantId +Account Environment Tenant TenantId ------- ----------- ------------------------------------ ------------------------------------ user@contoso.com TeamsGCCH xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` -### Example 4: Connect to MicrosoftTeams using Access Tokens -This example demonstrates how to sign in using Access Tokens. Admin can retrieve Access Tokens via the login.microsoftonline.com endpoint. It requires two tokens, MS Graph Access Token and Teams Resource token. +### Example 4: Connect to MicrosoftTeams using a certificate thumbprint +This example demonstrates how to authenticate using a certificate thumbprint. Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, please see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```powershell +Connect-MicrosoftTeams -CertificateThumbprint "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" +``` + +### Example 5: Connect to MicrosoftTeams using a certificate object +This example demonstrates how to authenticate using a certificate object. The Certificate parameter is available from Teams PowerShell Module version 4.9.2-preview or later. For details about application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```powershell +$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2("C:\exampleCert.pfx",$password) +Connect-MicrosoftTeams -Certificate $cert -ApplicationId "00000000-0000-0000-0000-000000000000" -TenantId "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" +``` + +### Example 6: Connect to MicrosoftTeams using Application-based Access Tokens +This example demonstrates how to authenticate with an application using Access Tokens. Access Tokens can be retrieved via the login.microsoftonline.com endpoint. It requires two Access Tokens: "MS Graph" and "Skype and Teams Tenant Admin API" resources. + +Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```powershell +$ClientSecret = "..." +$ApplicationID = "00000000-0000-0000-0000-000000000000" +$TenantID = "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY" + +$graphtokenBody = @{ + Grant_Type = "client_credentials" + Scope = "https://graph.microsoft.com/.default" + Client_Id = $ApplicationID + Client_Secret = $ClientSecret +} + +$graphToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $graphtokenBody | Select-Object -ExpandProperty Access_Token + +$teamstokenBody = @{ + Grant_Type = "client_credentials" + Scope = "48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default" + Client_Id = $ApplicationID + Client_Secret = $ClientSecret +} + +$teamsToken = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$TenantID/oauth2/v2.0/token" -Method POST -Body $teamstokenBody | Select-Object -ExpandProperty Access_Token + +Connect-MicrosoftTeams -AccessTokens @("$graphToken", "$teamsToken") +``` + +### Example 7: Connect to MicrosoftTeams using Access Tokens in the delegated flow +This example demonstrates how to sign in using Access Tokens. Admin can retrieve Access Tokens via the login.microsoftonline.com endpoint. It requires two tokens, MS Graph Access Token and Teams Resource token. A delegated flow, such as Resource Owner Password Credentials (ROPC) or device code, must be used, with the following delegated app permissions required. @@ -90,6 +163,10 @@ A delegated flow, such as Resource Owner Password Credentials (ROPC) or device c | Microsoft Graph | Delegated | User.Read.All | | Microsoft Graph | Delegated | Group.ReadWrite.All | | Microsoft Graph | Delegated | AppCatalog.ReadWrite.All | +| Microsoft Graph | Delegated | TeamSettings.ReadWrite.All | +| Microsoft Graph | Delegated | Channel.Delete.All | +| Microsoft Graph | Delegated | ChannelSettings.ReadWrite.All | +| Microsoft Graph | Delegated | ChannelMember.ReadWrite.All | | Skype and Teams Tenant Admin API | Delegated | user_impersonation | ```powershell @@ -112,7 +189,7 @@ $GraphToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=https://g $TeamsToken = (Invoke-RestMethod @RequestParameters -Body "$Body&scope=48ac35b8-9aa8-4d74-927d-1f4a14a0b239/.default").access_token Connect-MicrosoftTeams -AccessTokens @($GraphToken, $TeamsToken) -Account Environment Tenant TenantId +Account Environment Tenant TenantId ------- ----------- ------------------------------------ ------------------------------------ user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` @@ -120,23 +197,25 @@ user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxx ## PARAMETERS ### AccessTokens -Specifies a access tokens for "MSGraph" and "Skype and Teams Tenant Admin API" resources. This new parameter is added in version 2.3.2-preview. - -Following steps must be performed by Tenant Admin in the Azure portal when using your own application. - -Steps to configure the AAD application. -1. Go to Azure portal and go to App Registrations. -2. Create or select the existing application. -3. Add the following permission to this Application. -4. Click API permissions. -5. Click Add a permission. -6. Click on the Microsoft MS Graph, and then select Delegated Permission. -7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All"; -8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. -9. Navigate to "APIs my organization uses" -10. Search for "Skype and Teams Tenant Admin API". -11. Add all the listed permissions. -12. Grant admin consent to both MS Graph and "Skype and Teams Tenant Admin API" name. +Specifies access tokens for "MS Graph" and "Skype and Teams Tenant Admin API" resources. Both the tokens used should be of the same type. + +- Application-based authentication has been reintroduced with version 4.7.1-preview. For details and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +- Delegated flow - The following steps must be performed by Tenant Admin in the Azure portal when using your own application. + + Steps to configure the Microsoft Entra application. + 1. Go to Azure portal and go to App Registrations. + 2. Create or select the existing application. + 3. Add the following permission to this Application. + 4. Click API permissions. + 5. Click Add a permission. + 6. Click on the Microsoft Graph, and then select Delegated permissions. + 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All", "TeamSettings.ReadWrite.All", "Channel.Delete.All", "ChannelSettings.ReadWrite.All", "ChannelMember.ReadWrite.All". + 8. Next, we need to add "Skype and Teams Tenant Admin API" resource permission. Click Add a permission. + 9. Navigate to "APIs my organization uses" + 10. Search for "Skype and Teams Tenant Admin API", and then select Delegated permissions. + 11. Add all the listed permissions. + 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. ```yaml Type: String[] @@ -149,7 +228,7 @@ Accept wildcard characters: False ``` ### -AadAccessToken (Removed from version 2.3.2-preview) -Specifies a Azure Active Directory Graph access token. +Specifies an Azure Active Directory Graph access token. > [!WARNING] >This parameter has been removed from version 2.3.2-preview. @@ -180,10 +259,9 @@ Accept wildcard characters: False ``` ### -ApplicationId -Specifies the application ID of the service principal. +Specifies the application ID of the service principal that is used in application-based authentication. -> [!WARNING] ->This parameter has been removed from the latest versions and replaced by the AccessTokens parameter. +This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). ```yaml Type: String @@ -196,10 +274,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CertificateThumbprint (Removed from version 2.4.1-preview) -Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action. -> [!WARNING] ->This parameter has been removed from version 2.4.1-preview. +### -Certificate +Specifies the certificate that is used for application-based authentication. A valid value is the X509Certificate2 object value of the certificate. + +This parameter has been introduced with version 4.9.2-preview. For more information about application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). + +```yaml +Type: X509Certificate2 +Parameter Sets: ServicePrincipalCertificate +Aliases: CertificateThumbprint + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +Specifies the certificate thumbprint of a digital public key X.509 certificate of an application that has permission to perform this action. + +This parameter has been reintroduced with version 4.7.1-preview. For more information about Application-based authentication and supported cmdlets, see [Application-based authentication in Teams PowerShell Module](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication). ```yaml Type: String @@ -259,7 +354,7 @@ Accept wildcard characters: False ``` ### -LogLevel -Specifies the log level. +Specifies the log level. The acceptable values for this parameter are: - Info @@ -341,9 +436,12 @@ Accept wildcard characters: False ``` ### -TeamsEnvironmentName -Use this setting if your organization is in one of the Teams Government Cloud environments. +Specifies the Teams environment. The following environments are supported: -Specify "TeamsGCCH" if your organization is in the GCC High Environment. Specify "TeamsDOD" if your organization is in the DoD Environment. + - Commercial or GCC environments: Don't use this parameter, this is the default. + - GCC High environment: TeamsGCCH + - DoD environment: TeamsDOD + - Microsoft Teams operated by 21Vianet: TeamsChina ```yaml Type: String @@ -357,7 +455,10 @@ Accept wildcard characters: False ``` ### -Identity -Login using managed service identity in the current environment. This is currently not supported for *-Cs cmdlets. +Login using managed service identity in the current environment. For *-Cs cmdlets, this is supported from version 5.8.1-preview onwards. + +> [!Note] +> This is currently only supported in commercial environments. A few [cmdlets](https://learn.microsoft.com/microsoftteams/teams-powershell-application-authentication#cmdlets-supported) that don't support application-based authentication are not supported either. ```yaml Type: SwitchParameter @@ -412,10 +513,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseDeviceAuthentication +Use device code authentication instead of a browser control. + +```yaml +Type: SwitchParameter +Parameter Sets: UserCredential +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Disable-CsOnlineSipDomain.md b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md similarity index 75% rename from skype/skype-ps/skype/Disable-CsOnlineSipDomain.md rename to teams/teams-ps/teams/Disable-CsOnlineSipDomain.md index 77fc680bc6..932a55f2fe 100644 --- a/skype/skype-ps/skype/Disable-CsOnlineSipDomain.md +++ b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/disable-csonlinesipdomain -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain +applicable: Microsoft Teams title: Disable-CsOnlineSipDomain schema: 2.0.0 manager: bulenteg @@ -15,7 +15,7 @@ ms.reviewer: rogupta ## SYNOPSIS This cmdlet prevents provisioning of users in Skype for Business Online for the specified domain. This cmdlet allows organizations with multiple on-premises deployments of Skype For Business Server or Lync Server to safely synchronize users from multiple forests into a single Office 365 tenant. - + ## SYNTAX ```powershell @@ -23,7 +23,7 @@ Disable-CsOnlineSipDomain -Domain [-Force] [-Confirm] [1 O365 tenant is not supported. -- At any given time, only 1 on-premises SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) +- At any given time, only 1 on-premises SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) -- If 1 deployment is in hybrid mode, all sip domains from any other SfB forests must be disabled using this cmdlet before they can be synchronized into the tenant with Azure AD Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. +- If 1 deployment is in hybrid mode, all sip domains from any other SfB forests must be disabled using this cmdlet before they can be synchronized into the tenant with Microsoft Entra Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. -- Organizations must fully migrate each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the "hybrid" deployment, *before* moving on to migrate the next on-premises SfB deployment. +- Organizations must fully migrate each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the "hybrid" deployment, *before* moving on to migrate the next on-premises SfB deployment. -This cmdlet may also be useful for organizations with on-premises deployments of Skype for Business Server that have not properly configured Azure AD Connect. If the organization does not sync msRTCSIP-DeploymentLocator for its users, then Skype for Business Online will attempt to provision online any users with an assigned Skype for Business license, despite there being users on-premises. While the correct fix is to update the configuration for Azure AD Connect to sync those attributes, using Disable-CsOnlineSipDomain can also mitigate the problem until that configuration change can be made. If this cmdlet is run, any users that were previously provisioned online in that domain will be de-provisioned in Skype for Business Online. +This cmdlet may also be useful for organizations with on-premises deployments of Skype for Business Server that have not properly configured Microsoft Entra Connect. If the organization does not sync msRTCSIP-DeploymentLocator for its users, then Skype for Business Online will attempt to provision online any users with an assigned Skype for Business license, despite there being users on-premises. While the correct fix is to update the configuration for Microsoft Entra Connect to sync those attributes, using Disable-CsOnlineSipDomain can also mitigate the problem until that configuration change can be made. If this cmdlet is run, any users that were previously provisioned online in that domain will be de-provisioned in Skype for Business Online. Important: This cmdlet should not be run for domains that contain users hosted in Skype for Business Online. Any users in a sip domain that are already provisioned *online* will cease to function if you disable the online sip domain: - Their SIP addresses will be removed. @@ -45,7 +45,7 @@ Important: This cmdlet should not be run for domains that contain users hosted i - These users will no longer be able to login to the Skype for Business Online environment. - If these users use Teams, they will no longer be able to inter-operate with Skype for Business users, nor will they be able to federate with any users in other organizations. -Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Business Online, Online SIP Domains must be disabled in all regions. You must execute this cmdlet in each region that is added in Allowed Data Location. +Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Business Online, Online SIP Domains must be disabled in all regions. You must execute this cmdlet in each region that is added in Allowed Data Location. ## EXAMPLES @@ -67,7 +67,7 @@ The SIP domain to be disabled for online provisioning in Skype for Business Onli Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -99,7 +99,7 @@ Suppresses all confirmation prompts that might occur when running the command. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -107,11 +107,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -127,8 +125,8 @@ This cmdlet is for advanced scenarios only. Organizations that are pure online o ## RELATED LINKS -[Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) -[Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) -[Cloud consolidation for Teams and Skype for Business](https://docs.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) +[Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md index fcd345fd35..84d184eb9d 100644 --- a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md @@ -5,7 +5,7 @@ title: Disable-CsTeamsShiftsConnectionErrorReport author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport +online version: https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport schema: 2.0.0 --- @@ -25,7 +25,7 @@ Disable-CsTeamsShiftsConnectionErrorReport -ErrorReportId [ [-Force] [-Confirm] [ 1 O365 tenant is not supported. +- There must be at most 1 O365 tenant involved. Consolidation for scenarios with > 1 O365 tenant is not supported. -- At any given time, only 1 on-premises SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) +- At any given time, only 1 on-premises SfB forest can be in hybrid mode (Shared Sip Address Space) with Office 365. All other on-premises SfB forests must remain on-premises. (They presumably are federated with each other.) -- If 1 deployment is in hybrid mode, all online SIP domains from any other SfB forests must be disabled before they can be synchronized into the tenant with Azure AD Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. +- If 1 deployment is in hybrid mode, all online SIP domains from any other SfB forests must be disabled before they can be synchronized into the tenant with Microsoft Entra Connect. Users in all SfB forests other than the hybrid forest must remain on-premises. -- Organizations must fully migrate (e.g move all users to the cloud) each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the "hybrid" deployment, *before* moving on to migrate the next on-premises SfB deployment. +- Organizations must fully migrate (e.g move all users to the cloud) each SfB forest individually into the O365 tenant using hybrid mode (Shared Sip Address Space), and then detach the "hybrid" deployment, *before* moving on to migrate the next on-premises SfB deployment. -Before running this cmdlet for any SIP domain in a Skype for Business Server deployment, you must complete migration of any other existing hybrid SfB deployment that is in progress. All users in an existing hybrid deployment must be moved to the cloud, and that existing hybrid deployment must be detached from Office 365, as described in this article: [Disable hybrid to complete migration to the cloud](https://docs.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid). +Before running this cmdlet for any SIP domain in a Skype for Business Server deployment, you must complete migration of any other existing hybrid SfB deployment that is in progress. All users in an existing hybrid deployment must be moved to the cloud, and that existing hybrid deployment must be detached from Office 365, as described in this article: [Disable hybrid to complete migration to the cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid). -Important: If you have more than one on-premises deployment of Skype for Business Server, you *must* ensure SharedSipAddressSpace is disabled in all other Skype for Business Server deployments except the deployment containing the SIP domain that is being enabled. +Important: If you have more than one on-premises deployment of Skype for Business Server, you *must* ensure SharedSipAddressSpace is disabled in all other Skype for Business Server deployments except the deployment containing the SIP domain that is being enabled. -Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Business Online, Online SIP Domains must be Enabled in all regions. You must execute this cmdlet in each region that is added in Allowed Data Location for Skype for Business. +Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Business Online, Online SIP Domains must be Enabled in all regions. You must execute this cmdlet in each region that is added in Allowed Data Location for Skype for Business. ## EXAMPLES @@ -48,7 +48,7 @@ Note: If the Tenant is enabled for Regionally Hosted Meetings in Skype for Busin Enable-CsOnlineSipDomain -Domain contoso.com ``` -Enables the domain contoso.com for online provisioning in Skype for Business Online. +Enables the domain contoso.com for online provisioning in Skype for Business Online. ## PARAMETERS @@ -60,7 +60,7 @@ The SIP domain to be enabled for online provisioning in Skype for Business Onlin Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -76,7 +76,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -92,7 +92,7 @@ Suppresses all confirmation prompts that might occur when running the command. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -102,9 +102,8 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, --OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, +-OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -118,6 +117,6 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) -[Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +[Get-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain) diff --git a/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md b/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md new file mode 100644 index 0000000000..2af9e62f5d --- /dev/null +++ b/teams/teams-ps/teams/Export-CsAcquiredPhoneNumber.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber +applicable: Microsoft Teams +title: Export-CsAcquiredPhoneNumber +author: pavellatif +ms.author: pavellatif +ms.reviewer: +manager: roykuntz +schema: 2.0.0 +--- + +# Export-CsAcquiredPhoneNumber + +## SYNOPSIS +This cmdlet exports the list of phone numbers acquired by Teams Phone tenant. + +## SYNTAX + +``` +Export-CsAcquiredPhoneNumber [-Property ] [] +``` + +## DESCRIPTION +This cmdlet exports all the acquired phone numbers by the tenant to a file. The cmdlet is an asynchronus operation and will return an OrderId. [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) cmdlet can be used to check the status of the OrderId including the download link to exported file. + +By default, this cmdlet returns all the phone numbers acquired by the tenant with all corresponding properties in the results. The tenant admin may indicate specific properties as an input to get a list with only selected properties in the file. + +**Available properties to use are**: + +- TelephoneNumber +- OperatorId +- NumberType +- LocationId +- CivicAddressId +- NetworkSiteId +- AvailableCapabilities +- AcquiredCapabilities +- AssignmentStatus +- PlaceName +- ActivationState +- PartnerName +- IsoCountryCode +- PortInOrderStatus +- CapabilityUpdateSupported +- AcquisitionDate +- TargetId +- TargetType +- AssignmentCategory +- CallingProfileId +- IsoSubdivisionCode +- NumberSource +- SupportedCustomerActions +- ReverseNumberLookup +- RoutingOptions + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Export-CsAcquiredPhoneNumber +``` +```output +0e923e2c-ab0e-4b7a-be5a-906be8c +``` +This example displays the output of the export acquired phone numbers operation. The OrderId shown as the output string and can be used to get the download link for the file. + +### Example 2 +```powershell +PS C:\> Export-CsAcquiredPhoneNumber -Property "TelephoneNumber, NumberType, AssignmentStatus" +``` +```output +0e923e2c-ab0e-6h8c-be5a-906be8c +``` +This example displays the output of the export acquired phone numbers operation with filtered properties. This file will only contain the properties indicated. + +### Example 3 +```powershell +PS C:\> $orderId = Export-CsAcquiredPhoneNumber +``` +This example displays the use of variable "orderId" for the export acquired phone numbers operation. The OrderId string will be stored in the variable named "orderId" and no output will be shown for the cmdlet. + +### Example 4 +```powershell +PS C:\> Export-CsAcquiredPhoneNumber -Property "TelephoneNumber, NumberType, AssignmentStatus" +``` +```output +OrderId : 0e923e2c-ab0e-6h8c-be5a-906be8c +``` +This example displays the use of variable "orderId" for the export acquired phone numbers operation with filtered properties. The OrderId string will be stored in the variable named "orderId" and no output will be shown for the cmdlet. + +## PARAMETERS + +### -Property +{{ Fill Property Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES +The cmdlet is available in Teams PowerShell module 6.1.0 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) diff --git a/skype/skype-ps/skype/Export-CsAutoAttendantHolidays.md b/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md similarity index 87% rename from skype/skype-ps/skype/Export-CsAutoAttendantHolidays.md rename to teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md index 2b1973b519..610335e471 100644 --- a/skype/skype-ps/skype/Export-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/teams/Export-CsAutoAttendantHolidays.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csautoattendantholidays -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays +applicable: Microsoft Teams title: Export-CsAutoAttendantHolidays schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Export-CsAutoAttendantHolidays @@ -59,7 +59,7 @@ The identity for the AA whose holiday schedules are to be exported. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -74,7 +74,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -84,8 +84,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -96,13 +95,10 @@ The Export-CsAutoAttendantHolidays cmdlet accepts a string as the Identity param ### System.Byte[] - ## NOTES - ## RELATED LINKS -[Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) - -[Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) diff --git a/skype/skype-ps/skype/Find-CsGroup.md b/teams/teams-ps/teams/Find-CsGroup.md similarity index 78% rename from skype/skype-ps/skype/Find-CsGroup.md rename to teams/teams-ps/teams/Find-CsGroup.md index e9c1465c42..18c265455b 100644 --- a/skype/skype-ps/skype/Find-CsGroup.md +++ b/teams/teams-ps/teams/Find-CsGroup.md @@ -1,13 +1,9 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/find-csgroup -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/find-csgroup +applicable: Microsoft Teams title: Find-CsGroup schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Find-CsGroup @@ -18,7 +14,7 @@ Use the Find-CsGroup cmdlet to search groups. ## SYNTAX ``` -Find-CsGroup [-Tenant ] -SearchQuery [-MaxResults ] [-ExactMatchOnly ] +Find-CsGroup [-Tenant ] -SearchQuery [-MaxResults ] [-ExactMatchOnly ] [-MailEnabledOnly ] [-Force] [] ``` @@ -49,8 +45,8 @@ The SearchQuery parameter defines a search query to search the display name or t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -65,8 +61,8 @@ The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -81,8 +77,8 @@ PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -97,8 +93,23 @@ The MaxResults parameter identifies the maximum number of results to return. If ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailEnabledOnly +Instructs the cmdlet to return mail enabled only groups. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -113,8 +124,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -124,7 +135,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -133,11 +144,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel -The Find-CsGroup cmdlet returns a list of Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel. Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel contains Id and DisplayName. - +The Find-CsGroup cmdlet returns a list of Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel. Microsoft.Rtc.Management.Hosted.Group.Models.GroupModel contains Id and DisplayName. ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md similarity index 74% rename from skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md index 60d2854232..2744bd46e0 100644 --- a/skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/find-csonlineapplicationinstance -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance +applicable: Microsoft Teams title: Find-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,7 +18,7 @@ Use the Find-CsOnlineApplicationInstance cmdlet to find application instances th ## SYNTAX ``` -Find-CsOnlineApplicationInstance -SearchQuery [-MaxResults ] [-ExactMatchOnly] [-AssociatedOnly] [-UnAssociatedOnly] [-Tenant ] [-CommonParameters] +Find-CsOnlineApplicationInstance [-SearchQuery] [[-MaxResults] ] [-ExactMatchOnly] [-AssociatedOnly] [-UnAssociatedOnly] [-Force] [] ``` ## DESCRIPTION @@ -65,7 +65,7 @@ The SearchQuery parameter defines a query for application instances by display n Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: True Position: Named @@ -81,7 +81,7 @@ The ExactMatchOnly parameter instructs the cmdlet to return exact matches only. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -97,7 +97,7 @@ The AssociatedOnly parameter instructs the cmdlet to return only application ins Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -113,7 +113,7 @@ The UnAssociatedOnly parameter instructs the cmdlet to return only application i Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -129,7 +129,7 @@ The MaxResults parameter identifies the maximum number of results to return. If Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -138,34 +138,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named -Default value: None +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). +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.Hosted.Online.Models.FindApplicationInstanceResult - ## NOTES ## RELATED LINKS + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Get-ALLM365TeamsApps.md b/teams/teams-ps/teams/Get-ALLM365TeamsApps.md new file mode 100644 index 0000000000..b3dd4967bb --- /dev/null +++ b/teams/teams-ps/teams/Get-ALLM365TeamsApps.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-ALLM365TeamsApps +applicable: Microsoft Teams +title: Get-ALLM365TeamsApps +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 04/24/2024 +schema: 2.0.0 +--- + +# Get-AllM365TeamsApps + +## SYNOPSIS + +This cmdlet returns all Microsoft Teams apps in the app catalog, including Microsoft, custom, and non-Microsoft apps. + +## SYNTAX + +```powershell +Get-AllM365TeamsApps [] +``` + +## DESCRIPTION + +Get-AllM365TeamsApps retrieves a complete list of all Teams apps in an organization, their statuses, and their availability information. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-AllM365TeamsApps +``` + +Returns a complete list of all Teams apps in an organization, their statuses, and their availability information. + +### Example 2 + +```powershell +PS C:\> Get-AllM365TeamsApps | Select-Object -Property Id, IsBlocked, AvailableTo -ExpandProperty AvailableTo +``` + +Returns a complete list of all Teams apps in an organization, their statuses, and their availability information in expanded format. + +### Example 3 + +```powershell +PS C:\> Get-AllM365TeamsApps | Select-Object -Property Id, IsBlocked, AvailableTo, InstalledFor -ExpandProperty InstalledFor +``` + +Returns a complete list of all Teams apps in an organization, their statuses, their availability and their installation information in expanded format. + +## 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 + +**Id** +Application ID of the Teams app. + +**IsBlocked** +The state of the app in the tenant. +Values: + +- Blocked +- Unblocked + +**AvailableTo** +Provides available to properties for the app. +Properties: + +- AssignmentType: App availability type. + Values: + - Everyone + - UsersandGroups + - Noone +- LastUpdatedTimestamp: Time and date when the app AvailableTo value was last updated. +- AssignedBy: UserID of the last user who updated the app available to value. + +**InstalledFor** +Provides installation status for the app. +Properties: + +- AppInstallType: App availability type. + Values: + - Everyone + - UsersandGroups + - Noone +- LastUpdatedTimestamp: Time and date when the app AvailableTo value was last updated. +- InstalledBy: UserID of the last user who installed the app available to value. +- InstalledSource: Source of Installation +- Version: Version of the app installed + +## NOTES + +## RELATED LINKS + +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-m365teamsapp) diff --git a/teams/teams-ps/teams/Get-AssociatedTeam.md b/teams/teams-ps/teams/Get-AssociatedTeam.md new file mode 100644 index 0000000000..2bc7566964 --- /dev/null +++ b/teams/teams-ps/teams/Get-AssociatedTeam.md @@ -0,0 +1,81 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-associatedteam +title: Get-AssociatedTeam +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-AssociatedTeam + +## SYNOPSIS +This cmdlet supports retrieving all teams associated with a user, including teams which host shared channels. + +## SYNTAX +```PowerShell +Get-AssociatedTeam [-User ] [] +``` + +## DESCRIPTION +This cmdlet supports retrieving all associated teams of a user, including teams which host shared channels. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-AssociatedTeam +``` + +Returns associated teams of the current user. + +### Example 2 +```PowerShell +Get-AssociatedTeam -user example@example.com +``` + +Returns associated teams of a given user email. + +### Example 3 +```PowerShell +Get-AssociatedTeam -user 0e4249a7-6cfd-8c93-a510-91cda44c8c73 +``` + +Returns associated teams of a given user ID. + +## PARAMETERS + +### -User +User's UPN (user principal name, for example +johndoe@example.com) or user ID (for example 0e4249a7-6cfd-8c93-a510-91cda44c8c73). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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/?LinkID=113216). + +## INPUTS + +### User + +## OUTPUTS + +### Team + +## NOTES + +## RELATED LINKS +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-SharedWithTeam](https://learn.microsoft.com/powershell/module/teams/get-team) diff --git a/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..a3cd76b4a4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsApplicationAccessPolicy.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csapplicationaccesspolicy +applicable: Microsoft Teams +title: Get-CsApplicationAccessPolicy +schema: 2.0.0 +manager: zhengni +author: frankpeng7 +ms.author: frpeng +ms.reviewer: +--- + +# Get-CsApplicationAccessPolicy + +## SYNOPSIS + +Retrieves information about the application access policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsApplicationAccessPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsApplicationAccessPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +This cmdlet retrieves information about the application access policy configured for use in the tenant. + +## EXAMPLES + +### Retrieve all application access policies + +```powershell +PS C:\> Get-CsApplicationAccessPolicy +``` + +The command shown above returns information of all application access policies that have been configured for use in the tenant. + +### Retrieve specific application access policy + +```powershell +PS C:\> Get-CsApplicationAccessPolicy -Identity "ASimplePolicy" +``` + +In the command shown above, information is returned for a single application access policy: the policy with the Identity ASimplePolicy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) + +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) + +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csapplicationaccesspolicy) + +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csapplicationaccesspolicy) diff --git a/skype/skype-ps/skype/Get-CsApplicationMeetingConfiguration.md b/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsApplicationMeetingConfiguration.md rename to teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md index a3a2f0a9e8..0980ee7a04 100644 --- a/skype/skype-ps/skype/Get-CsApplicationMeetingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsApplicationMeetingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-CsApplicationMeetingConfiguration +online version: https://learn.microsoft.com/powershell/module/teams/get-CsApplicationMeetingConfiguration applicable: Teams title: Get-CsApplicationMeetingConfiguration schema: 2.0.0 @@ -21,7 +21,7 @@ Retrieves information about the application meeting configuration settings confi ### Identity ``` -Get-CsApplicationMeetingConfiguration [-Identity ] +Get-CsApplicationMeetingConfiguration [-Identity ] [] ``` ## DESCRIPTION @@ -38,7 +38,6 @@ PS C:\> Get-CsApplicationMeetingConfiguration The command shown above returns application meeting configuration settings that have been configured for the tenant. - ## PARAMETERS ### -Identity @@ -50,7 +49,7 @@ However, you can use the following syntax to retrieve the global settings: -Iden ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -67,7 +66,7 @@ However, if you prefer, you can use syntax similar to this to retrieve the globa ```yaml Type: String Parameter Sets: Filter -Aliases: +Aliases: Applicable: Teams Required: False @@ -83,7 +82,7 @@ Retrieves the application meeting configuration data from the local replica of t ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Teams Required: False @@ -94,7 +93,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -108,4 +107,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) +[Set-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csapplicationmeetingconfiguration) diff --git a/skype/skype-ps/skype/Get-CsAutoAttendant.md b/teams/teams-ps/teams/Get-CsAutoAttendant.md similarity index 75% rename from skype/skype-ps/skype/Get-CsAutoAttendant.md rename to teams/teams-ps/teams/Get-CsAutoAttendant.md index c49b32a2c6..7fc22623fe 100644 --- a/skype/skype-ps/skype/Get-CsAutoAttendant.md +++ b/teams/teams-ps/teams/Get-CsAutoAttendant.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautoattendant -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendant +applicable: Microsoft Teams title: Get-CsAutoAttendant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAutoAttendant @@ -31,7 +31,7 @@ The Get-CsAutoAttendant cmdlet returns information about the AAs in your organiz Get-CsAutoAttendant ``` -This example gets all AAs in the organization. +This example gets the first 100 auto attendants in the organization. ### Example 2 ```powershell @@ -71,7 +71,6 @@ Get-CsAutoAttendant -Skip 5 -First 10 This example skips initial 5 auto attendants and gets the next 10 AAs configured in the organization. - ## PARAMETERS ### -Identity @@ -82,7 +81,7 @@ If you specify this parameter, you can't specify the other parameters. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -92,13 +91,15 @@ Accept wildcard characters: False ``` ### -First -The First parameter indicates the maximum number of auto attendants to retrieve as the result. It is intended to be used for pagination purposes. +The First parameter gets the first N auto attendants, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 auto attendants. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. +If a number greater than 100 is supplied, the request will fail. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -108,13 +109,13 @@ Accept wildcard characters: False ``` ### -Skip -The Skip parameter indicates the number of initial auto attendants to skip in the result. It is intended to be used for pagination purposes. +The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -130,7 +131,7 @@ If specified, only auto attendants whose names match that value would be returne Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -146,7 +147,7 @@ If specified, the retrieved auto attendants would be sorted by the specified pro Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -162,7 +163,7 @@ If specified, the retrieved auto attendants would be sorted in descending order. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -178,7 +179,7 @@ If specified, the status records for each auto attendant in the result set are a Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -194,7 +195,7 @@ If specified, only auto attendants' names, identities and associated application Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -209,7 +210,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -219,31 +220,27 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String The Get-CsAutoAttendant cmdlet accepts a string as the Identity parameter. - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant - ## NOTES - ## RELATED LINKS -[Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) -[New-CsAutoAttendant](New-CsAutoAttendant.md) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) -[Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) -[Set-CsAutoAttendant](Set-CsAutoAttendant.md) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) -[Update-CsAutoAttendant](Update-CsAutoAttendant.md) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) diff --git a/skype/skype-ps/skype/Get-CsAutoAttendantHolidays.md b/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md similarity index 85% rename from skype/skype-ps/skype/Get-CsAutoAttendantHolidays.md rename to teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md index 9877afeeac..92114b548b 100644 --- a/skype/skype-ps/skype/Get-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/teams/Get-CsAutoAttendantHolidays.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautoattendantholidays -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays +applicable: Microsoft Teams title: Get-CsAutoAttendantHolidays schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAutoAttendantHolidays @@ -63,7 +63,7 @@ Represents the identifier for the auto attendant whose holidays are to be retrie Type: System.String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -73,13 +73,13 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -94,7 +94,7 @@ The Years parameter represents the years for the holidays to be retrieved. If th Type: System.Collections.Generic.List[System.String] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -110,7 +110,7 @@ The Names parameter represents the names for the holidays to be retrieved. If th Type: System.Collections.Generic.List[System.Int32] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -120,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -136,6 +136,6 @@ The DateTimeRanges parameter in the output needs to be explicitly referenced to ## RELATED LINKS -[Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) -[Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) diff --git a/skype/skype-ps/skype/Get-CsAutoAttendantStatus.md b/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md similarity index 86% rename from skype/skype-ps/skype/Get-CsAutoAttendantStatus.md rename to teams/teams-ps/teams/Get-CsAutoAttendantStatus.md index 914a882129..69b5630115 100644 --- a/skype/skype-ps/skype/Get-CsAutoAttendantStatus.md +++ b/teams/teams-ps/teams/Get-CsAutoAttendantStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautoattendantstatus -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus +applicable: Microsoft Teams title: Get-CsAutoAttendantStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAutoAttendantStatus @@ -15,18 +15,15 @@ ms.reviewer: ## SYNOPSIS Use Get-CsAutoAttendantStatus cmdlet to get the status of an Auto Attendant (AA) provisioning. - ## SYNTAX ``` Get-CsAutoAttendantStatus -Identity [-IncludeResources ] [-Tenant ] [] ``` - ## DESCRIPTION This cmdlet provides a way to return the provisioning status of an auto attendant configured for use in your organization. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -52,7 +49,7 @@ Represents the identifier for the auto attendant whose provisioning status is to Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -72,7 +69,7 @@ Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: Accepted values: AudioFile, DialByNameVoiceResponses, SipProvisioning -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -87,7 +84,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -97,7 +94,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -112,5 +109,4 @@ The Get-CsAutoAttendantStatus cmdlet accepts a string as the Identity parameter. ## RELATED LINKS -[Get-CsAutoAttendant](Get-CsAutoAttendant.md) - +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) diff --git a/skype/skype-ps/skype/Get-CsAutoAttendantSupportedLanguage.md b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md similarity index 85% rename from skype/skype-ps/skype/Get-CsAutoAttendantSupportedLanguage.md rename to teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md index d8b9c694b9..c6cb4253af 100644 --- a/skype/skype-ps/skype/Get-CsAutoAttendantSupportedLanguage.md +++ b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedLanguage.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautoattendantsupportedlanguage -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage +applicable: Microsoft Teams title: Get-CsAutoAttendantSupportedLanguage schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAutoAttendantSupportedLanguage @@ -49,7 +49,7 @@ The Identity parameter designates a specific language to be retrieved. If this p Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -64,7 +64,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -74,7 +74,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -85,8 +85,6 @@ The Get-CsAutoAttendantSupportedLanguage cmdlet accepts a string as the Identity ### Microsoft.Rtc.Management.Hosted.OAA.Models.Language - ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAutoAttendantSupportedTimeZone.md b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md similarity index 84% rename from skype/skype-ps/skype/Get-CsAutoAttendantSupportedTimeZone.md rename to teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md index 89b540ffb4..1e0491d7e4 100644 --- a/skype/skype-ps/skype/Get-CsAutoAttendantSupportedTimeZone.md +++ b/teams/teams-ps/teams/Get-CsAutoAttendantSupportedTimeZone.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautoattendantsupportedtimezone -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone +applicable: Microsoft Teams title: Get-CsAutoAttendantSupportedTimeZone schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAutoAttendantSupportedTimeZone @@ -40,7 +40,6 @@ Get-CsAutoAttendantSupportedTimeZone -Identity "Pacific Standard Time" This example gets the timezone that the Identity parameter specifies (Pacific Standard Time). - ## PARAMETERS ### -Identity @@ -50,7 +49,7 @@ The Identity parameter specifies a time zone to be retrieved. If this parameter Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -65,7 +64,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -75,7 +74,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -88,9 +87,6 @@ The Get-CsAutoAttendantSupportedTimeZone cmdlet accepts a string as the Identity ### Microsoft.Rtc.Management.Hosted.OAA.Models.TimeZone - ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsAutoAttendantTenantInformation.md b/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md similarity index 80% rename from skype/skype-ps/skype/Get-CsAutoAttendantTenantInformation.md rename to teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md index e761af416e..92a3a9bbc1 100644 --- a/skype/skype-ps/skype/Get-CsAutoAttendantTenantInformation.md +++ b/teams/teams-ps/teams/Get-CsAutoAttendantTenantInformation.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csautoattendanttenantinformation -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csautoattendanttenantinformation +applicable: Microsoft Teams title: Get-CsAutoAttendantTenantInformation schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAutoAttendantTenantInformation @@ -33,7 +33,6 @@ Get-CsAutoAttendantTenantInformation Gets the default auto attendant information for the logged in tenant. - ## PARAMETERS ### -Tenant @@ -42,7 +41,7 @@ Gets the default auto attendant information for the logged in tenant. Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -52,7 +51,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -65,4 +64,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md index cd0e9b35ad..b9a3895727 100644 --- a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation +online version: https://learn.microsoft.com/powershell/module/teams/get-csbatchpolicyassignmentoperation +title: Get-CsBatchPolicyAssignmentOperation schema: 2.0.0 author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsBatchPolicyAssignmentOperation @@ -210,8 +211,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -266,4 +266,4 @@ Contains the status for each user in the batch. ## RELATED LINKS -[New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) +[New-CsBatchPolicyAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation) diff --git a/teams/teams-ps/teams/Get-CsBatchTeamsDeployment.md b/teams/teams-ps/teams/Get-CsBatchTeamsDeployment.md deleted file mode 100644 index 02fdb410c6..0000000000 --- a/teams/teams-ps/teams/Get-CsBatchTeamsDeployment.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csbatchteamsdeployment -schema: 2.0.0 ---- - -# Get-CsBatchTeamsDeployment - -## SYNOPSIS - -This cmdlet is used to get the status of the batch deployment orchestration. - -## SYNTAX - -``` -Get-CsBatchTeamsDeployment -OrchestrationId [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeployment. - -To learn more, see [Deploy Teams at scale for frontline workers](https://docs.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-CsBatchTeamsDeployment -OrchestrationId "My-Orchestration-Id" -``` -This command provides the status of the specified batch deployment orchestrationId. - - -## PARAMETERS - -### OrchestrationId -This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## OUTPUTS -### Status of the orchestrationId - - -Running: The orchestration is running. -Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. - - -## NOTES - -## RELATED LINKS - -[New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) diff --git a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md b/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md new file mode 100644 index 0000000000..2fdd9166f2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsBatchTeamsDeploymentStatus +title: Get-CsBatchTeamsDeploymentStatus +schema: 2.0.0 +--- + +# Get-CsBatchTeamsDeploymentStatus + +## SYNOPSIS + +This cmdlet is used to get the status of the batch deployment orchestration. + +## SYNTAX + +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId + -InputObject + [] +``` + +## DESCRIPTION +After deploying teams using New-CsBatchTeamsDeployment, an admin can check the status of the job/orchestration using Get-CsBatchTeamsDeploymentStatus. + +To learn more, see [Deploy Teams at scale for frontline workers](https://learn.microsoft.com/microsoft-365/frontline/deploy-teams-at-scale). + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Get-CsBatchTeamsDeploymentStatus -OrchestrationId "My-Orchestration-Id" +``` + +This command provides the status of the specified batch deployment orchestrationId. + +## PARAMETERS + +### OrchestrationId +This ID is generated when a batch deployment is submitted with the New-CsBatchTeamsDeployment cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Status of the orchestrationId + +Running: The orchestration is running. +Completed: The orchestration is completed, either succeeded, partially succeeded, or failed. + +## NOTES + +## RELATED LINKS + +[New-CsBatchTeamsDeployment](https://learn.microsoft.com/powershell/module/teams/new-csbatchteamsdeployment) diff --git a/skype/skype-ps/skype/Get-CsCallQueue.md b/teams/teams-ps/teams/Get-CsCallQueue.md similarity index 75% rename from skype/skype-ps/skype/Get-CsCallQueue.md rename to teams/teams-ps/teams/Get-CsCallQueue.md index ffaf7e00e6..9ea06bec8e 100644 --- a/skype/skype-ps/skype/Get-CsCallQueue.md +++ b/teams/teams-ps/teams/Get-CsCallQueue.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscallqueue -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cscallqueue +applicable: Microsoft Teams title: Get-CsCallQueue schema: 2.0.0 ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsCallQueue @@ -18,7 +19,7 @@ The Get-CsCallQueue cmdlet returns the identified Call Queues. ## SYNTAX ``` -Get-CsCallQueue [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] +Get-CsCallQueue [-Identity ] [-Tenant ] [-First ] [-Skip ] [-ExcludeContent ] [-Sort ] [-Descending ] [-NameFilter ] [] ``` ## DESCRIPTION @@ -31,7 +32,7 @@ The Get-CsCallQueue cmdlet lets you retrieve information about the Call Queues i Get-CsCallQueue ``` -This example gets all Call Queues in the organization. +This example gets the first 100 call queues in the organization. ### -------------------------- Example 2 -------------------------- ``` @@ -40,7 +41,6 @@ Get-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 This example gets the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Call Queue exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - ## PARAMETERS ### -Identity @@ -49,8 +49,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -65,8 +65,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -76,13 +76,15 @@ Accept wildcard characters: False ``` ### -First -The First parameter gets the first N Call Queues. The default behavior is to return the first 100 number of queues. It is intended to be used for pagination purposes. +The First parameter gets the first N Call Queues, up to a maximum of 100 at a time. +When not specified, the default behavior is to return the first 100 call queues. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes. +If a number greater than 100 is supplied, the request will fail. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -92,13 +94,13 @@ Accept wildcard characters: False ``` ### -Skip -The Skip parameter skips the first N Call Queues. It is intended to be used for pagination purposes. +The Skip parameter skips the first N call queues. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -113,8 +115,8 @@ The ExcludeContent parameter only displays the Name and Id of the Call Queues ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -129,8 +131,8 @@ The Sort parameter specifies the property used to sort. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -145,8 +147,8 @@ The Descending parameter sorts Call Queues in descending order ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -161,8 +163,8 @@ The NameFilter parameter returns Call Queues where name contains specified strin ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -172,19 +174,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Identity Represents the unique identifier of a Call Queue. - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsCallingLineIdentity.md b/teams/teams-ps/teams/Get-CsCallingLineIdentity.md similarity index 68% rename from skype/skype-ps/skype/Get-CsCallingLineIdentity.md rename to teams/teams-ps/teams/Get-CsCallingLineIdentity.md index be51e09a77..bbd56f2336 100644 --- a/skype/skype-ps/skype/Get-CsCallingLineIdentity.md +++ b/teams/teams-ps/teams/Get-CsCallingLineIdentity.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cscallinglineidentity -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity +applicable: Microsoft Teams title: Get-CsCallingLineIdentity schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -54,8 +54,8 @@ The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (Identity) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -70,8 +70,8 @@ The Filter parameter lets you insert a string through which your search results ```yaml Type: String Parameter Sets: (Filter) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -81,8 +81,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -94,10 +93,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) -[Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) -[New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) -[Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md new file mode 100644 index 0000000000..f2b7e131f9 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md @@ -0,0 +1,62 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsCloudCallDataConnection +online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection +schema: 2.0.0 +author: 2012ucp1544 +ms.author: uditagrawal +ms.reviewer: pbafna +manager: subadjat + +--- + +# Get-CsCloudCallDataConnection + +## SYNOPSIS +This cmdlet retrieves an already existing online call data connection. + +## SYNTAX + +```powershell +Get-CsCloudCallDataConnection [] +``` + +## DESCRIPTION +This cmdlet retrieves an already existing online call data connection. Output of this cmdlet contains a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsCloudCallDataConnection + +Token +----- +00000000-0000-0000-0000-000000000000 +``` + +Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + +## 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 + +The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. + +## RELATED LINKS + +[Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) +[New-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection) diff --git a/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..9d668b7749 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: Get-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +Get-CsComplianceRecordingForCallQueueTemplate [-Id ] [] +``` + +## DESCRIPTION +Use the Get-CsComplianceRecordingForCallQueueTemplate cmdlet to retrieve a Compliance Recording for Call Queues template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsComplianceRecordingForCallQueueTemplate +``` + +This example gets all Compliance Recording for Call Queue Templates in the organization. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example gets the Compliance Recording for Call Queue template with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Compliance Recording for Call Queue template exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Id +The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Get-CsDialPlan.md b/teams/teams-ps/teams/Get-CsDialPlan.md new file mode 100644 index 0000000000..f7d347abb0 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsDialPlan.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csdialplan +applicable: Microsoft Teams +title: Get-CsDialPlan +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsDialPlan + +## SYNOPSIS +Returns information about the dial plans used in your organization. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Get-CsDialPlan [-Tenant ] [[-Identity] ] [-LocalStore] [] +``` + +### Filter +``` +Get-CsDialPlan [-Tenant ] [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION +This cmdlet returns information about one or more dial plans (also known as a location profiles) in an organization. +Dial plans provide information required to enable Enterprise Voice users to make telephone calls. +Dial plans are also used by the Conferencing Attendant application for dial-in conferencing. +A dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. + +Note: You can use the Get-CsDialPlan cmdlet to retrieve specific information about the normalization rules of a dial plan, but if that's the only dial plan information you need, you can also use the Get-CsVoiceNormalizationRule cmdlet. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsDialPlan +``` + +Example 1 returns a collection of all the dial plans configured for use in your organization; this is done by calling the Get-CsDialPlan cmdlet without any additional parameters. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsDialPlan -Identity RedmondDialPlan +``` + +In Example 2, the Identity parameter is used to limit the retrieved data to dial plans that have a per-user dial plan with the Identity RedmondDialPlan. +Because identities must be unique, this command will return only the specified dial plan. + +### -------------------------- Example 3 -------------------------- +``` +Get-CsDialPlan -Identity site:Redmond +``` + +Example 3 is identical to Example 2 except that instead of retrieving a per-user dial plan, we're retrieving a dial plan assigned to a site. +We do that by specifying the value site: followed by the site name (in this case Redmond) of the site we want to retrieve. + +### -------------------------- Example 4 -------------------------- +``` +Get-CsDialPlan -Filter tag:* +``` + +This example uses the Filter parameter to return a collection of all the dial plans that have been configured at the per-user scope. +(Settings configured at the per-user, or tag, scope can be directly assigned to users and groups.) The wildcard string tag:* instructs the cmdlet to return only those dial plans that have an identity beginning with the string value tag:, which identifies a dial plan as a per-user dial plan. + +### -------------------------- Example 5 -------------------------- +``` +Get-CsDialPlan | Select-Object -ExpandProperty NormalizationRules +``` + +This example displays the normalization rules used by the dial plans configured for use in your organization. +Because the NormalizationRules property consists of an array of objects, the complete set of normalization rules is typically not displayed on screen. +To see all of these rules, this sample command first uses the Get-CsDialPlan cmdlet to retrieve a collection of all the dial plans. +That collection is then piped to the Select-Object cmdlet; in turn, the ExpandProperty parameter of the Select-Object cmdlet is used to "expand" the values found in the NormalizationRules property. +Expanding the values simply means that all the normalization rules will be listed out individually on the screen, the same output that would be seen if the Get-CsVoiceNormalizationRule cmdlet had been called. + +### -------------------------- Example 6 -------------------------- +``` +Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} +``` + +In Example 6, the Get-CsDialPlan cmdlet and the Where-Object cmdlet are used to retrieve a collection of all the dial plans that include the word Redmond in their description. +To do this, the command first uses the Get-CsDialPlan cmdlet to retrieve all the dial plans. +That collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to profiles that have the word Redmond somewhere in their Description. + +## PARAMETERS + +### -Identity +The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Performs a wildcard search that allows you to narrow down your results to only dial plans with identities that match the given wildcard string. + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Retrieves the dial plan information from the local replica of the Central Management store, rather than the Central Management store itself. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + +## NOTES + +## RELATED LINKS + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/skype/skype-ps/skype/Get-CsEffectiveTenantDialPlan.md b/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md similarity index 83% rename from skype/skype-ps/skype/Get-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md index f196b40dd2..e7be699f75 100644 --- a/skype/skype-ps/skype/Get-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/teams/Get-CsEffectiveTenantDialPlan.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cseffectivetenantdialplan -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cseffectivetenantdialplan +applicable: Microsoft Teams title: Get-CsEffectiveTenantDialPlan schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -23,7 +23,7 @@ Get-CsEffectiveTenantDialPlan [-Identity] [-OU ## DESCRIPTION The Get-CsEffectiveTenantDialPlan cmdlet returns information about the effective tenant dial plan in an organization. -The returned effective Tenant Dial Plan contains the EffectiveTenantDialPlanName and the Normalization rules that are effective for the user while using +The returned effective Tenant Dial Plan contains the EffectiveTenantDialPlanName and the Normalization rules that are effective for the user while using the EnterpriseVoice features. The EffectiveTenantDialPlanName is in the form TenantGUID_GlobalVoiceDialPlan_TenantDialPlan. ## EXAMPLES @@ -35,7 +35,6 @@ Get-CsEffectiveTenantDialPlan -Identity Vt1_User1 This example gets the effective tenant dial plan for the Vt1_User1. - ## PARAMETERS ### -Identity @@ -44,8 +43,8 @@ The Identity parameter is the unique identifier of the user for whom to retrieve ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -61,7 +60,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -79,8 +78,8 @@ Only objects that exist in the specified location are returned. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -99,8 +98,8 @@ If set to 0, the command will run, but no data will be returned. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -117,7 +116,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -127,17 +126,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS - ## OUTPUTS - ## NOTES - ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md b/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md new file mode 100644 index 0000000000..1571bfb68b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsExportAcquiredPhoneNumberStatus.md @@ -0,0 +1,107 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus +applicable: Microsoft Teams +title: Get-CsExportAcquiredPhoneNumberStatus +author: pavellatif +ms.author: pavellatif +ms.reviewer: +manager: roykuntz +schema: 2.0.0 +--- + +# Get-CsExportAcquiredPhoneNumberStatus + +## SYNOPSIS +This cmdlet shows the status of the [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. + +## SYNTAX + +### Get-CsExportAcquiredPhoneNumberStatus (Default) +``` +Get-CsExportAcquiredPhoneNumberStatus -OrderId [] +``` + +## DESCRIPTION +This cmdlet returns OrderId status from the respective [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) operation. The response will include the download link to the file if operation has been completed. + +By default, the download link will remain active for 1 hour. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsExportAcquiredPhoneNumberStatus -OrderId 0e923e2c-ab0e-4b7a-be5a-906be8c +``` +```output +Id : 0e923e2c-ab0e-4b7a-be5a-906be8c +CreatedAt : 2024-08-29 21:50:54Z +status : Success +DownloadLinkExpiry : 2024-08-29 22:51:17Z +DownloadLink : +``` +This example displays the status of the export acquired phone numbers operation. The OrderId is the output from [Export-CsAcquiredPhoneNumber](https://learn.microsoft.com/powershell/module/teams/export-csacquiredphonenumber) cmdlet. The status contains the download link for the file along with expiry date. + +### Example 2 +```powershell +PS C:\> Get-CsExportAcquiredPhoneNumberStatus -OrderId $orderId +``` +```output +Id : 0e923e2c-ab0e-4b7a-be5a-906be8c +CreatedAt : 2024-08-29 21:50:54Z +status : Success +DownloadLinkExpiry : 2024-08-29 22:51:17Z +DownloadLink : +``` +This example displays the status of the export acquired phone numbers operation with the use of a variable named "orderId". + +### Example 3 +```powershell +PS C:\> $order = Get-CsExportAcquiredPhoneNumberStatus -OrderId $orderId +PS C:\> $order +``` +```output +Id : 0e923e2c-ab0e-4b7a-be5a-906be8c +CreatedAt : 2024-08-29 21:50:54Z +status : Success +DownloadLinkExpiry : 2024-08-29 22:51:17Z +DownloadLink : +``` +This example stores the [Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) cmdlet status for the "orderId" in the variable "order". This will allow a quick view of the order status without typing the cmdlet again. + +## PARAMETERS + +### -OrderId +The orderId of the ExportAcquiredNumberStatus cmdlet. + +```yaml +Type: String +Parameter Sets: Get +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 + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISkypeTelephoneNumberMgmtGetExportAcquiredTelephoneNumbersResponse + +## NOTES +The cmdlet is available in Teams PowerShell module 6.1.0 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsExportAcquiredPhoneNumberStatus](https://learn.microsoft.com/powershell/module/teams/get-csexportacquiredphonenumberstatus) diff --git a/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..6b5e5dfbaa --- /dev/null +++ b/teams/teams-ps/teams/Get-CsExternalAccessPolicy.md @@ -0,0 +1,282 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy +applicable: Microsoft Teams +title: Get-CsExternalAccessPolicy +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsExternalAccessPolicy + +## SYNOPSIS +Returns information about the external access policies that have been configured for use in your organization. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Get-CsExternalAccessPolicy [-Tenant ] [-Include ] [-ApplicableTo ] + [[-Identity] ] [-LocalStore] [] +``` + +### Filter +``` +Get-CsExternalAccessPolicy [-Tenant ] [-Include ] [-ApplicableTo ] + [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION +When you first configure Skype for Business Online your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Online organization or in your Active Directory Domain Services for on-premises deployments. + +For on-premises deployments, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +The Get-CsExternalAccessPolicy cmdlet provides a way for you to return information about all of the external access policies that have been configured for use in your organization. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +Get-CsExternalAccessPolicy +``` + +Example 1 returns a collection of all the external access policies configured for use in your organization. +Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. + +### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) +``` +Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" +``` + +Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. +Because access policy Identities must be unique, this command will never return more than one item. + +### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +``` +Get-CsExternalAccessPolicy -Identity site:Redmond +``` + +Example 2 uses the Identity parameter to return the external access policy that has the Identity site:Redmond. +Because access policy Identities must be unique, this command will never return more than one item. + +### -------------------------- Example 3 -------------------------- +``` +Get-CsExternalAccessPolicy -Filter tag:* +``` + +The command shown in Example 3 uses the Filter parameter to return all of the external access policies that have been configured at the per-user scope; the parameter value "tag:*" limits returned data to those policies that have an Identity that begins with the string value "tag:". +By definition, any policy that has an Identity beginning with "tag:" is a policy that has been configured at the per-user scope. + +### -------------------------- Example 4 -------------------------- +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} +``` + +In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet are used to return all the external access policies that grant users federation access. +To do this, the Get-CsExternalAccessPolicy cmdlet is first used to return a collection of all the external access policies currently in use in the organization. +This collection is then piped to the Where-Object cmdlet, which selects only those policies where the EnableFederationAccess property is equal to True. + +### -------------------------- Example 5 -------------------------- +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} +``` + +The command shown in Example 5 returns the external access policies that meet two criteria: both federation access and public cloud access are allowed. +In order to perform this task, the command first uses the Get-CsExternalAccessPolicy cmdlet to return a collection of all the access policies in use in the organization. +That collection is then piped to the Where-Object cmdlet, which picks out only those policies that meet two criteria: the EnableFederationAccess property must be equal to True and the EnablePublicCloudAccess property must also be equal to True. +Only policies in which both EnableFederationAccess and EnablePublicCloudAccess are True will be returned and displayed on the screen. + +### -------------------------- EXAMPLE 6 -------------------------- +``` +Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" +``` + +In Example 6, the ApplicableTo parameter is used to return only the policies that can be assigned to the user "kenmyer@litwareinc.com". + +NOTE: The ApplicableTo parameter can only be used with Skype for Business Online; that's because, with Skype for Business Online, there might be policies that cannot be assigned to certain users due to licensing and/or country/region restrictions. + +NOTE: This command requires the Office 365 UsageLocation property to be configured for the user's Active Directory user account. + +## PARAMETERS + +### -Identity +Unique Identity assigned to the policy when it was created. +External access policies can be assigned at the global, site, or per-user scope. +To refer to the global instance use this syntax: -Identity global. +To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. +To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. + +Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. +To do a wildcard search for policies, use the Filter parameter instead. + +If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +**Below Content Applies To:** Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 + +Enables you to do a wildcard search for external access policies. +For example, to find all the policies configured at the site scope, use this Filter: + +`site:*` + +To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: + +`"S*".` + +Note that the Filter parameter can only be applied to the policy Identity. + +**Below Content Applies To:** Skype for Business Online + +Enables you to do a wildcard search for external access policies. +For example, to find all the policies configured at the per-user scope, use this Filter: + +`"tag:*"` + +To find the per-user policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: + +`"tag:S*"` + +Note that the Filter parameter can only be applied to the policy Identity. + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +NOTE: This parameter is not used with Skype for Business Online. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicableTo +Returns a list of the external access policies that can be assigned to the specified user. +For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: + +`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` + +The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. +This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. +For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. +If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. + +The ApplicableTo parameter applies only to Skype for Business Online. +This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Include +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly + +```yaml +Type: PolicyFilter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy + +## NOTES + +## RELATED LINKS + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md index 1d2bf67620..015cc6cfd9 100644 --- a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md @@ -1,11 +1,9 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment +online version: https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment +title: Get-CsGroupPolicyAssignment schema: 2.0.0 -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Get-CsGroupPolicyAssignment @@ -16,8 +14,8 @@ This cmdlet is used to return group policy assignments. ## SYNTAX -``` -Get-CsGroupPolicyAssignment [-GroupId ] [-PolicyType ] +```powershell +Get-CsGroupPolicyAssignment [-GroupId ] [-PolicyType ] [] ``` ## DESCRIPTION @@ -28,8 +26,8 @@ This cmdlets returns group policy assignments. Optional parameters allow the re ### Example 1 In this example, all group policy assignments are returned. -``` -Get-CsGroupPolicyAssignment +```powershell +Get-CsGroupPolicyAssignment GroupId PolicyType PolicyName Rank CreatedTime CreatedBy ------- ---------- ---------- ---- ----------- --------- @@ -45,7 +43,7 @@ e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling ### Example 2 In this example, only the policies assigned to a specific group are returned. -``` +```powershell Get-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 GroupId PolicyType PolicyName Rank CreatedTime CreatedBy @@ -60,7 +58,7 @@ In this example, only the policies of a specific type are returned. Get-CsGroupPolicyAssignment -PolicyType TeamsCallingPolicy -``` +```powershell GroupId PolicyType PolicyName Rank CreatedTime CreatedBy ------- ---------- ---------- ---- ----------- --------- e2a3ed24-97be-494d-8d3c-dbc04cbb878a TeamsCallingPolicy AllowCalling 1 11/4/2019 12:54:27 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 @@ -87,6 +85,44 @@ Accept wildcard characters: False ### -PolicyType The policy type for which group policy assignments will be returned. +Possible values: + +ApplicationAccessPolicy +CallingLineIdentity +ExternalAccessPolicy +OnlineAudioConferencingRoutingPolicy +OnlineVoicemailPolicy +OnlineVoiceRoutingPolicy +TeamsAppSetupPolicy +TeamsAudioConferencingPolicy +TeamsCallHoldPolicy +TeamsCallingPolicy +TeamsCallParkPolicy +TeamsChannelsPolicy +TeamsComplianceRecordingPolicy +TeamsCortanaPolicy +TeamsEmergencyCallingPolicy +TeamsEmergencyCallRoutingPolicy +TeamsEnhancedEncryptionPolicy +TeamsEventsPolicy +TeamsFeedbackPolicy +TeamsFilesPolicy +TeamsIPPhonePolicy +TeamsMediaLoggingPolicy +TeamsMeetingBrandingPolicy +TeamsMeetingBroadcastPolicy +TeamsMeetingPolicy +TeamsMeetingTemplatePermissionPolicy +TeamsMessagingPolicy +TeamsMobilityPolicy +TeamsRoomVideoTeleConferencingPolicy +TeamsSharedCallingRoutingPolicy +TeamsShiftsPolicy +TeamsUpdateManagementPolicy +TeamsVdiPolicy +TeamsVideoInteropServicePolicy +TeamsVirtualAppointmentsPolicy +TenantDialPlan ```yaml Type: String @@ -101,8 +137,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -112,8 +147,8 @@ For more information, see [About CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md index ebbebc000e..15b1d9e69b 100644 --- a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md @@ -1,13 +1,15 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber +online version: https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Get-CsHybridTelephoneNumber schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: + --- # Get-CsHybridTelephoneNumber @@ -15,11 +17,14 @@ schema: 2.0.0 ## SYNOPSIS This cmdlet displays information about one or more hybrid telephone numbers. +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **Get-CsPhoneNumberAssignment** cmdlet to display information about one or more phone numbers. Detailed instructions on how to use the new cmdlet can be found at [Get-CsPhoneNumberAssignment](/powershell/module/teams/get-csphonenumberassignment?view=teams-ps) + ## SYNTAX ### Assignment (Default) ```powershell -Get-CsHybridTelephoneNumber [-TelephoneNumber ] [] +Get-CsHybridTelephoneNumber [-TelephoneNumber ] -InputObject [] ``` ## DESCRIPTION @@ -36,7 +41,7 @@ Get-CsHybridTelephoneNumber -TelephoneNumber 14025551234 ```output Id O365Region SourceType TargetType TelephoneNumber UserId -- ---------- ---------- ---------- --------------- ------ -14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 +14025551234 NOAM Hybrid 14025551234 00000000-0000-0000-0000-000000000000 ``` This example displays information about the phone number +1 (402) 555-1234. @@ -55,12 +60,12 @@ This example displays information about all hybrid telephone numbers in the tena ## PARAMETERS ### -TelephoneNumber -Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. +Filters the returned results to a specific phone number. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -69,6 +74,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +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). @@ -86,6 +106,6 @@ The cmdlet is available in Teams PowerShell module 4.5.0 or later. The cmdlet is only available in GCC High and DoD cloud instances. ## RELATED LINKS -[New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) +[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) -[Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) diff --git a/skype/skype-ps/skype/Get-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md similarity index 73% rename from skype/skype-ps/skype/Get-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md index bf561168a3..bf831c5aa7 100644 --- a/skype/skype-ps/skype/Get-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/teams/Get-CsInboundBlockedNumberPattern.md @@ -1,97 +1,96 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csinboundblockednumberpattern -applicable: Microsoft Teams, Skype for Business Online -title: Get-CsInboundBlockedNumberPattern -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: bulenteg -schema: 2.0.0 ---- - -# Get-CsInboundBlockedNumberPattern - -## SYNOPSIS -Returns a list of all blocked number patterns added to the tenant list. - -## SYNTAX - -### Identity (Default) -``` -Get-CsInboundBlockedNumberPattern [[-Identity] ] [] -``` - -### Filter -``` -Get-CsInboundBlockedNumberPattern [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet returns a list of all blocked number patterns added to the tenant list including Name, Description, Enabled (True/False), and Pattern for each. - -## EXAMPLES - -### Example 1 -```powershell -PS> Get-CsInboundBlockedNumberPattern -``` - -In this example, the *Get-CsInboundBlockedNumberPattern* cmdlet is called without any parameters in order to return all the blocked number patterns. - -### Example 2 -```powershell -PS> Get-CsInboundBlockedNumberPattern -Filter Block* -``` - -In this example, the *Get-CsInboundBlockedNumberPattern* cmdlet will return all the blocked number patterns which identity starts with Block. - - -## PARAMETERS - -### -Filter -Enables you to limit the returned data by filtering on the Identity. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the blocked number patterns to return. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) - -[Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) - -[Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Get-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# Get-CsInboundBlockedNumberPattern + +## SYNOPSIS +Returns a list of all blocked number patterns added to the tenant list. + +## SYNTAX + +### Identity (Default) +``` +Get-CsInboundBlockedNumberPattern [[-Identity] ] [] +``` + +### Filter +``` +Get-CsInboundBlockedNumberPattern [-Filter ] [] +``` + +## DESCRIPTION +This cmdlet returns a list of all blocked number patterns added to the tenant list including Name, Description, Enabled (True/False), and Pattern for each. + +## EXAMPLES + +### Example 1 +```powershell +PS> Get-CsInboundBlockedNumberPattern +``` + +In this example, the *Get-CsInboundBlockedNumberPattern* cmdlet is called without any parameters in order to return all the blocked number patterns. + +### Example 2 +```powershell +PS> Get-CsInboundBlockedNumberPattern -Filter Block* +``` + +In this example, the *Get-CsInboundBlockedNumberPattern* cmdlet will return all the blocked number patterns which identity starts with Block. + +## PARAMETERS + +### -Filter +Enables you to limit the returned data by filtering on the Identity. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the blocked number patterns to return. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) + +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) + +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) diff --git a/skype/skype-ps/skype/Get-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md similarity index 59% rename from skype/skype-ps/skype/Get-CsInboundExemptNumberPattern.md rename to teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md index ce8606ef22..9f59ffa49a 100644 --- a/skype/skype-ps/skype/Get-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/teams/Get-CsInboundExemptNumberPattern.md @@ -1,103 +1,107 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csinboundexemptnumberpattern -applicable: Microsoft Teams, Skype for Business Online -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Get-CsInboundExemptNumberPattern - -## SYNOPSIS -Returns a specific or the full list of all number patterns exempt from call blocking. - -## SYNTAX - -### Identity (Default) -``` -Get-CsInboundBlockedNumberPattern [[-Identity] ] [] -``` - -### Filter -``` -Get-CsInboundBlockedNumberPattern [-Filter ] [] -``` - -## DESCRIPTION -This cmdlet returns a specific or all exempt number patterns added to the tenant list for call blocking including Name, Description, Enabled (True/False), and Pattern for each. - -## EXAMPLES - -### Example 1 -```powershell -PS>Get-CsInboundExemptNumberPattern -``` -This returns all exempt number patterns. - -### Example 2 -```powershell -PS>Get-CsInboundExemptNumberPattern -Identity "Exempt1" -``` - -This returns the exempt number patterns with Identity Exempt1. - -### Example 3 -```powershell -PS>Get-CsInboundExemptNumberPattern -Filter "Exempt*" -``` - -This example returns the exempt number patterns with Identity starting with Exempt. - -## PARAMETERS - -### -Filter -Enables you to limit the returned data by filtering on Identity. - -```yaml -Type: String -Parameter Sets: (Filter) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the exempt number pattern to be listed. - -```yaml -Type: String -Parameter Sets: (Identity) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. - -## RELATED LINKS -[New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) - -[Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) - -[Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) - -[Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) - -[Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: Get-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Get-CsInboundExemptNumberPattern + +## SYNOPSIS +Returns a specific or the full list of all number patterns exempt from call blocking. + +## SYNTAX + +### Identity (Default) +``` +Get-CsInboundBlockedNumberPattern [[-Identity] ] [] +``` + +### Filter +``` +Get-CsInboundBlockedNumberPattern [-Filter ] [] +``` + +## DESCRIPTION +This cmdlet returns a specific or all exempt number patterns added to the tenant list for call blocking including Name, Description, Enabled (True/False), and Pattern for each. + +## EXAMPLES + +### Example 1 +```powershell +PS>Get-CsInboundExemptNumberPattern +``` +This returns all exempt number patterns. + +### Example 2 +```powershell +PS>Get-CsInboundExemptNumberPattern -Identity "Exempt1" +``` + +This returns the exempt number patterns with Identity Exempt1. + +### Example 3 +```powershell +PS>Get-CsInboundExemptNumberPattern -Filter "Exempt*" +``` + +This example returns the exempt number patterns with Identity starting with Exempt. + +## PARAMETERS + +### -Filter +Enables you to limit the returned data by filtering on Identity. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the exempt number pattern to be listed. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +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 + +## OUTPUTS + +## NOTES + +You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. + +## RELATED LINKS +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) + +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) + +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md b/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md similarity index 52% rename from skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md rename to teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md index 00f2dbeaef..36129dc3a8 100644 --- a/skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md +++ b/teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csmeetingmigrationstatus -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus +applicable: Microsoft Teams title: Get-CsMeetingMigrationStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsMeetingMigrationStatus @@ -17,8 +17,7 @@ You use the `Get-CsMeetingMigrationStatus` cmdlet to check the status of meeting ## SYNTAX ``` -Get-CsMeetingMigrationStatus [[-Identity] ] [-Confirm] [-EndTime ] [-StartTime ] - [-SummaryOnly] [-Tenant ] [-WhatIf] [-State ] [] +Get-CsMeetingMigrationStatus [[-Identity] ] [-EndTime ] [-StartTime ] [-SummaryOnly] [-State ] [] ``` ## DESCRIPTION @@ -42,7 +41,6 @@ Get-CsMeetingMigrationStatus -Identity "ashaw@contoso.com" This example gets the meeting migration status for user ashaw@contoso.com. - ## PARAMETERS ### -Identity @@ -51,8 +49,8 @@ Specifies the Identity of the user account to be to be modified. A user identity ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 3 @@ -61,30 +59,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -StartTime Specifies the start date of the date range. ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -99,8 +81,8 @@ Specifies the end date of the date range. ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -115,48 +97,8 @@ Specified that you want a summary status of MMS migrations returned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -167,16 +109,17 @@ Accept wildcard characters: False ### -State With this parameter you can filter by migration state. Possible values are: -* Pending -* InProgress -* Failed -* Succeeded + +- Pending +- InProgress +- Failed +- Succeeded ```yaml Type: StateType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -186,17 +129,37 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES +CorrelationId : 849d3e3b-3e1d-465f-8dde-785aa9e3f856 +CreateDate : 2024-04-27T00:24:00.1442688Z +FailedMeeting : 0 +InvitesUpdate : 0 +LastMessage : +MigrationType : AllToTeams +ModifiedDate : 2024-04-27T00:24:00.1442688Z +RetryCount : 0 +State : Pending +SucceededMeeting : 0 +TotalMeeting : 0 +UserId : 27c6ee67-c71d-4386-bf84-ebfdc7c3a171 +UserPrincipalName : syntest1-prod@TESTTESTMMSSYNTHETICUSWESTT.onmicrosoft.com + +where **MigrationType** can have the following values: + +- **SfbToTeams** (Skype for Business On-prem to Teams) +- **TeamsToTeams** (Teams to Teams) +- **ToSameType** (Same source and target meeting types) +- **AllToTeams** (All types to Teams) ## RELATED LINKS -[Get-CsTenantMigrationConfiguration](https://docs.microsoft.com/powershell/module/skype/get-cstenantmigrationconfiguration?view=skype-ps) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) -[Get-CsOnlineDialInConferencingTenantSettings](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingtenantsettings?view=skype-ps) +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) -[Start-CsExMeetingMigration](https://docs.microsoft.com/powershell/module/skype/start-csexmeetingmigration?view=skype-ps) +[Start-CsExMeetingMigration](https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration) diff --git a/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..c153103192 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance +applicable: Microsoft Teams +title: Get-CsOnlineApplicationInstance +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-CsOnlineApplicationInstance + +## SYNOPSIS +Get application instance for the tenant from Microsoft Entra ID. + +## SYNTAX + +``` +Get-CsOnlineApplicationInstance [[-Identity] ] [[-Identities] ] [[-ResultSize] ] [[-Skip] ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet is used to get details of an application instance. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com +``` + +This example returns the application instance with identity "appinstance01@contoso.com". +### -------------------------- Example 2 -------------------------- +```powershell +Get-CsOnlineApplicationInstance -Identities appinstance01@contoso.com,appinstance02@contoso.com +``` + +This example returns the application instance with identities "appinstance01@contoso.com" and "appinstance02@contoso.com". Query with multiple comma separated Identity. + +### -------------------------- Example 3 -------------------------- +```powershell +Get-CsOnlineApplicationInstance -ResultSize 10 +``` + +This example returns the first 10 application instances. + +### -------------------------- Example 4 -------------------------- +```powershell +Get-CsOnlineApplicationInstance +``` + +This example returns the details of all application instances. + +## PARAMETERS + +### -Identity +The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identities +The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The result size for bulk get. This parameter is currently not working. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Skips the first specified number of returned results. The default value is 0. This parameter is currently not working. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md similarity index 71% rename from skype/skype-ps/skype/Get-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md index 40ba7d0249..f837f328ee 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationinstanceassociation -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation +applicable: Microsoft Teams title: Get-CsOnlineApplicationInstanceAssociation schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineApplicationInstanceAssociation @@ -24,7 +24,6 @@ Get-CsOnlineApplicationInstanceAssociation -Identity [-Tenant ] [ ## DESCRIPTION Use the Get-CsOnlineApplicationInstanceAssociation cmdlet to get information about the associations setup between online application instances and the application configurations, like auto attendants and call queues. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -43,7 +42,7 @@ The identity for the application instance whose association is to be retrieved. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -58,7 +57,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -68,8 +67,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -80,14 +78,12 @@ The Get-CsOnlineApplicationInstanceAssociation cmdlet accepts a string as the Id ### Microsoft.Rtc.Management.Hosted.Online.Models.ApplicationInstanceAssociation - ## NOTES - ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) -[New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) -[Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md similarity index 72% rename from skype/skype-ps/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md rename to teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md index 63fb79a975..bf4db93e15 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md +++ b/teams/teams-ps/teams/Get-CsOnlineApplicationInstanceAssociationStatus.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineapplicationinstanceassociationstatus -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus +applicable: Microsoft Teams title: Get-CsOnlineApplicationInstanceAssociationStatus schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineApplicationInstanceAssociationStatus @@ -24,7 +24,6 @@ Get-CsOnlineApplicationInstanceAssociationStatus -Identity [-Tenant ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsOnlineAudioConferencingRoutingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsOnlineAudioConferencingRoutingPolicy +``` + +Retrieves all Online Audio Conferencing Routing Policy instances + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/skype/skype-ps/skype/Get-CsOnlineAudioFile.md b/teams/teams-ps/teams/Get-CsOnlineAudioFile.md similarity index 79% rename from skype/skype-ps/skype/Get-CsOnlineAudioFile.md rename to teams/teams-ps/teams/Get-CsOnlineAudioFile.md index d5e149eaff..65d7fc94b4 100644 --- a/skype/skype-ps/skype/Get-CsOnlineAudioFile.md +++ b/teams/teams-ps/teams/Get-CsOnlineAudioFile.md @@ -1,132 +1,132 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineaudiofile -applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Get-CsOnlineAudioFile - -## SYNOPSIS -Returns information about a specific or all uploaded audio files of a given application type. - - -## SYNTAX - -```powershell -Get-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] -``` - -## DESCRIPTION -This cmdlet returns information on a specific or all uploaded audio files of a given application type. If you are not specifying any parameters you will get information of all uploaded audio files with ApplicationId = TenantGlobal. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsOnlineAudioFile - -``` -```Output -Id : 85364afb59a143fc9466979e0f34f749 -FileName : CustomMoH.mp3 -ApplicationId : TenantGlobal -MarkedForDeletion : False -``` -This returns information about all uploaded audio files with ApplicationId = TenantGlobal. - -### Example 2 -```powershell -Get-CsOnlineAudioFile -ApplicationId HuntGroup -Identity dcfcc31daa9246f29d94d0a715ef877e - -``` -```Output -Id : dcfcc31daa9246f29d94d0a715ef877e -FileName : SupportCQ.mp3 -ApplicationId : HuntGroup -MarkedForDeletion : False -``` -This cmdlet returns information about the audio file with Id dcfcc31daa9246f29d94d0a715ef877e and with ApplicationId = HuntGroup. - -### Example 3 -```powershell -Get-CsOnlineAudioFile -ApplicationId OrgAutoAttendant - -``` -```Output -Id : 58083ae8bc9e4a66a6b2810b2e1f4e4e -FileName : MainAAAnnouncement.mp3 -ApplicationId : OrgAutoAttendant -MarkedForDeletion : False -``` -This cmdlet returns information about all uploaded audio files with ApplicationId = OrgAutoAttendant. - -## PARAMETERS - -### -ApplicationId -The ApplicationId parameter specifies the identifier for the application that was specified when audio file was uploaded. For example, if the audio file is used with an auto attendant, then it should specified as "OrgAutoAttendant". -If the audio file is used with a hunt group (call queue), then it needs to be specified as "HuntGroup". If the audio file is used for music on hold, the it needs to specified as "TenantGlobal". - -If you are not specifying an ApplicationId it is assumed to be TenantGlobal. - -Supported values: - -- OrgAutoAttendant -- HuntGroup -- TenantGlobal - -```yaml -Type: System.string -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: TenantGlobal -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Id of the specific audio file that you would like to see information about. If you are only specifying -Identity, the -ApplicationId it is assumed to be TenantGlobal. - -If you need to see the information of a specific audio file with ApplicationId of OrgAutoAttendant or HuntGroup, you need to specify -ApplicationId with the corresponding value and -Identity with the Id of the audio file. - - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -The cmdlet is available in Teams PS module 2.4.0-preview or later. - -If you call the cmdlet without having uploaded any audio files, with a non-existing Identity or with an illegal ApplicationId, you will receive a generic error message. In addition, the ApplicationId is case sensitive. - -## RELATED LINKS -[Export-CsOnlineAudioFile](Export-CsOnlineAudioFile.md) - -[Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) - -[New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) - -[Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile +applicable: Microsoft Teams +title: Get-CsOnlineAudioFile +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: + +--- + +# Get-CsOnlineAudioFile + +## SYNOPSIS +Returns information about a specific or all uploaded audio files of a given application type. + +## SYNTAX + +```powershell +Get-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] +``` + +## DESCRIPTION +This cmdlet returns information on a specific or all uploaded audio files of a given application type. If you are not specifying any parameters you will get information of all uploaded audio files with ApplicationId = TenantGlobal. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsOnlineAudioFile + +``` +```Output +Id : 85364afb59a143fc9466979e0f34f749 +FileName : CustomMoH.mp3 +ApplicationId : TenantGlobal +MarkedForDeletion : False +``` +This returns information about all uploaded audio files with ApplicationId = TenantGlobal. + +### Example 2 +```powershell +Get-CsOnlineAudioFile -ApplicationId HuntGroup -Identity dcfcc31daa9246f29d94d0a715ef877e + +``` +```Output +Id : dcfcc31daa9246f29d94d0a715ef877e +FileName : SupportCQ.mp3 +ApplicationId : HuntGroup +MarkedForDeletion : False +``` +This cmdlet returns information about the audio file with Id dcfcc31daa9246f29d94d0a715ef877e and with ApplicationId = HuntGroup. + +### Example 3 +```powershell +Get-CsOnlineAudioFile -ApplicationId OrgAutoAttendant + +``` +```Output +Id : 58083ae8bc9e4a66a6b2810b2e1f4e4e +FileName : MainAAAnnouncement.mp3 +ApplicationId : OrgAutoAttendant +MarkedForDeletion : False +``` +This cmdlet returns information about all uploaded audio files with ApplicationId = OrgAutoAttendant. + +## PARAMETERS + +### -ApplicationId +The ApplicationId parameter specifies the identifier for the application that was specified when audio file was uploaded. For example, if the audio file is used with an auto attendant, then it should specified as "OrgAutoAttendant". +If the audio file is used with a hunt group (call queue), then it needs to be specified as "HuntGroup". If the audio file is used for music on hold, the it needs to specified as "TenantGlobal". + +If you are not specifying an ApplicationId it is assumed to be TenantGlobal. + +Supported values: + +- OrgAutoAttendant +- HuntGroup +- TenantGlobal + +```yaml +Type: System.string +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TenantGlobal +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Id of the specific audio file that you would like to see information about. If you are only specifying -Identity, the -ApplicationId it is assumed to be TenantGlobal. + +If you need to see the information of a specific audio file with ApplicationId of OrgAutoAttendant or HuntGroup, you need to specify -ApplicationId with the corresponding value and -Identity with the Id of the audio file. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +The cmdlet is available in Teams PS module 2.4.0-preview or later. + +If you call the cmdlet without having uploaded any audio files, with a non-existing Identity or with an illegal ApplicationId, you will receive a generic error message. In addition, the ApplicationId is case sensitive. + +## RELATED LINKS +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md similarity index 94% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md index 588157bd79..8668124a9a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingBridge schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingBridge @@ -55,7 +55,6 @@ Get-CsOnlineDialInConferencingBridge -Tenant 26efe125-c070-46f9-8ed0-fc02165a167 This example shows how to return all of the audio conferencing bridges for the given tenant. - ## PARAMETERS ### -Identity @@ -64,7 +63,7 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -80,7 +79,7 @@ Specifies the name of the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -94,11 +93,11 @@ Accept wildcard characters: False Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter include: -Fully qualified domain name (FQDN): +Fully qualified domain name (FQDN): `-DomainController atl-cs-001.Contoso.com` -Computer name: +Computer name: `-DomainController atl-cs-001` @@ -125,7 +124,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -141,7 +140,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -157,7 +156,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -170,19 +169,14 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### None - ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md similarity index 93% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md index 55de125202..b8c773dd60 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingLanguagesSupported schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingLanguagesSupported @@ -37,8 +37,6 @@ Get-CsOnlineDialInConferencingLanguagesSupported | fl This example allows returns the list of supported languages when you are using Microsoft as your dial-in audio conferencing provider and displays them in a formatted list. - - ## PARAMETERS ### -DomainController @@ -70,7 +68,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -90,4 +88,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md similarity index 89% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md index 0933401a75..daa9adb621 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingservicenumber -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingServiceNumber schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingServiceNumber @@ -75,7 +75,6 @@ Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" This example returns all of the default service numbers for the audio conferencing bridge named "Conference Bridge". - ## PARAMETERS ### -BridgeId @@ -85,8 +84,8 @@ When it's used it returns all of the service numbers that are configured on the ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -101,8 +100,8 @@ Specifies the default dial-in service number string. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -117,8 +116,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -133,8 +132,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -150,8 +149,8 @@ When it is used it returns all of the service numbers that are configured on the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -167,8 +166,8 @@ When used it lists all of the service numbers for a specific city geocode. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -189,7 +188,7 @@ Computer name: `-DomainController atl-cs-001` Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -206,8 +205,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -228,8 +227,8 @@ If you set the ResultSize to 7 but you have only three users in your forest, the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -239,7 +238,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -248,4 +247,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md similarity index 82% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md index 852e1f44d8..5f1ea406de 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingtenantsettings -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingTenantSettings schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingTenantSettings @@ -40,7 +40,6 @@ Get-CsOnlineDialInConferencingTenantSettings This example returns the global setting for the tenant administrator's organization. - ## PARAMETERS ### -Filter @@ -49,8 +48,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -65,8 +64,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -81,8 +80,8 @@ Retrieves the settings from the local replica of the Central Management store ra ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -97,8 +96,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -108,21 +107,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.WritableConfig.Settings.OnLineDialInConferencing.OnLineDialInConferencingTenantSettings - ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUser.md b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md similarity index 87% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md index c3849cacab..7c7a3686cb 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialInConferencingUser.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencinguser +applicable: Microsoft Teams title: Get-CsOnlineDialInConferencingUser schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialInConferencingUser @@ -61,8 +61,8 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -80,8 +80,8 @@ Specifies the name for the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -98,8 +98,8 @@ You can also reference a user account by using the user's Active Directory disti ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -119,8 +119,8 @@ The service number can be specified in the following formats: E.164 number, +\] [-LocalStore] [] +Get-CsOnlineDialOutPolicy [[-Identity] ] [] ``` ### Filter ``` -Get-CsOnlineDialOutPolicy [-Filter ] [-LocalStore] [] +Get-CsOnlineDialOutPolicy [-Filter ] [] ``` ## DESCRIPTION -In Skype for Business Online, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. -To get all the available policies in your organization run `Get-CSOnlineDialOutPolicy`. +In Microsoft Teams, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. The policies apply to all the different PSTN connectivity options for Microsoft Teams; Calling Plan, Direct Routing, and Operator Connect. + +To get all the available policies in your organization run `Get-CsOnlineDialOutPolicy`. To assign one of these policies to a user run `Grant-CsDialoutPolicy`. ## EXAMPLES ### Example 1 ```powershell -PS C:\> Get-CSOnlineDialOutPolicy +Get-CsOnlineDialOutPolicy ``` -In Example 1, `Get-CSOnlineDialOutPolicy` is called without any additional parameters; this returns a collection of all the outbound calling restriction policies configured for use in your organization. +In Example 1, `Get-CsOnlineDialOutPolicy` is called without any additional parameters; this returns a collection of all the outbound calling restriction policies configured for use in your organization. ### Example 2 ```powershell -PS C:\> Get-CSOnlineDialOutPolicy -Identity DialoutCPCandPSTNDisabled +Get-CsOnlineDialOutPolicy -Identity DialoutCPCandPSTNDisabled ``` -In Example 2, `Get-CSOnlineDialOutPolicy` is used to return the per-user outbound calling restriction policy that has an Identity DialoutCPCandPSTNDisabled. Because identities are unique, this command will never return more than one item. +In Example 2, `Get-CsOnlineDialOutPolicy` is used to return the per-user outbound calling restriction policy that has an Identity DialoutCPCandPSTNDisabled. Because identities are unique, this command will never return more than one item. ## PARAMETERS ### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*". +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". ```yaml Type: String @@ -71,7 +72,7 @@ Unique identifier of the outbound calling restriction policy to be returned. To If this parameter is omitted, then all the outbound calling restriction policies configured for use in your tenant will be returned. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -82,24 +83,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -112,4 +97,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Grant-CsDialoutPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csdialoutpolicy) +[Grant-CsDialoutPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy) diff --git a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md similarity index 83% rename from skype/skype-ps/skype/Get-CsOnlineDialinConferencingPolicy.md rename to teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md index 156bb932b8..44a0e83fd6 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingPolicy.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingpolicy -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingpolicy +applicable: Microsoft Teams title: Get-CsOnlineDialinConferencingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialinConferencingPolicy @@ -39,7 +39,6 @@ Get-CsOnlineDialinConferencingPolicy This example retrieves all the available Dial in Conferencing policies in the tenant. - ## PARAMETERS ### -Filter @@ -48,8 +47,8 @@ This parameter accepts a wildcard string and returns all policies with identitie ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -64,8 +63,8 @@ A unique identifier specifying the scope and, in some cases the name, of the pol ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -80,8 +79,8 @@ Reserved for Microsoft Internal use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -91,7 +90,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md rename to teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md index 0408c9066b..7c1dbe713c 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md +++ b/teams/teams-ps/teams/Get-CsOnlineDialinConferencingTenantConfiguration.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingtenantconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantconfiguration +applicable: Microsoft Teams title: Get-CsOnlineDialinConferencingTenantConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDialinConferencingTenantConfiguration @@ -49,7 +49,6 @@ Get-CsOnlineDialinConferencingTenantConfiguration This example returns the configuration for the tenant administrator's organization. - ## PARAMETERS ### -Filter @@ -58,8 +57,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -74,8 +73,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -90,8 +89,8 @@ Retrieves the configuration from the local replica of the Central Management sto ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -106,8 +105,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -117,7 +116,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -127,9 +126,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Rtc.Management.WritableConfig.Settings.OnLineDialInConferencing.OnLineDialInConferencingTenantConfiguration - ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenant.md b/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md similarity index 84% rename from skype/skype-ps/skype/Get-CsOnlineDirectoryTenant.md rename to teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md index 52714b5c45..35a0ee1afb 100644 --- a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenant.md +++ b/teams/teams-ps/teams/Get-CsOnlineDirectoryTenant.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinedirectorytenant -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinedirectorytenant +applicable: Microsoft Teams title: Get-CsOnlineDirectoryTenant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineDirectoryTenant @@ -24,7 +24,6 @@ Get-CsOnlineDirectoryTenant [[-Tenant] ] [-DomainController ] [-Forc ## DESCRIPTION **Note**: Starting with Teams PowerShell Module 4.0, this cmdlet will be deprecated. Use the Get-CsTenant or Get-CsOnlineDialInConferencingBridge cmdlet to view information previously present in Get-CsOnlineDirectoryTenant. - Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve tenant parameters like AnnouncementsDisabled, NameRecordingDisabled and Bridges from the Business Voice Directory. ## EXAMPLES @@ -36,7 +35,6 @@ Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5 This example returns the tenant specified by GUID. - ## PARAMETERS ### -Confirm @@ -46,7 +44,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -63,7 +61,7 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -80,8 +78,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -92,19 +90,19 @@ Accept wildcard characters: False ### -Tenant Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: +For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -You can find your tenant ID by running this command: +You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -121,7 +119,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -131,22 +129,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacTenant - ## NOTES - ## RELATED LINKS -[Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) diff --git a/skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 80% rename from skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md index cc1b415fee..4c7b04e076 100644 --- a/skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineenhancedemergencyservicedisclaimer -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer +applicable: Microsoft Teams title: Get-CsOnlineEnhancedEmergencyServiceDisclaimer schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineEnhancedEmergencyServiceDisclaimer @@ -33,7 +33,6 @@ Get-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion "US" This example returns your organization's enhanced emergency service terms and conditions acceptance status. - ## PARAMETERS ### -CountryOrRegion @@ -43,8 +42,8 @@ The United States is currently the only country supported, but it must be specif ```yaml Type: CountryInfo Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -60,7 +59,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -77,8 +76,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -93,8 +92,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -109,8 +108,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -120,21 +119,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### None - ## NOTES - ## RELATED LINKS -[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://docs.microsoft.com/powershell/module/skype/set-csonlineenhancedemergencyservicedisclaimer?view=skype-ps) +[Set-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer) diff --git a/skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md similarity index 82% rename from skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md index 21bbfe4178..3a889df518 100644 --- a/skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineliscivicaddress -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress +applicable: Microsoft Teams title: Get-CsOnlineLisCivicAddress schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -55,7 +55,7 @@ Valid inputs are "Assigned", or "Unassigned". Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -71,7 +71,7 @@ Specifies the city of the target civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -87,7 +87,7 @@ Specifies the identity of the civic address to return. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -103,7 +103,7 @@ Specifies the country or region of the target civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -119,7 +119,7 @@ Specifies the administrator defined description of the target civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -137,7 +137,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -153,7 +153,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -163,11 +163,8 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip - -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. - Specifies the number of results to skip. -If there are a large number of civic addresses, you can limit the number of returns by using the ResultSize parameter. +If there are a large number of civic addresses, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. For example the command below will return civic addresses 26-50 for Seattle. @@ -177,7 +174,7 @@ For example the command below will return civic addresses 26-50 for Seattle. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -193,7 +190,7 @@ If present, the PopulateNumberOfTelephoneNumbers switch causes the cmdlet to pro Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -209,7 +206,7 @@ If present, the PopulateNumberOfVoiceUsers switch causes the cmdlet to provide t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -225,7 +222,7 @@ Specifies the maximum number of results to return. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -242,7 +239,7 @@ Valid inputs are: Valid, Invalid, and Notvalidated. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -261,8 +258,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](set-csonlineliscivicaddress.md) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](new-csonlineliscivicaddress.md) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](remove-csonlineliscivicaddress.md) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) diff --git a/skype/skype-ps/skype/Get-CsOnlineLisLocation.md b/teams/teams-ps/teams/Get-CsOnlineLisLocation.md similarity index 94% rename from skype/skype-ps/skype/Get-CsOnlineLisLocation.md rename to teams/teams-ps/teams/Get-CsOnlineLisLocation.md index 3de46f3cf8..2fb1346e9a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/Get-CsOnlineLisLocation.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinelislocation +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation applicable: Microsoft Teams title: Get-CsOnlineLisLocation schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -215,11 +215,8 @@ Accept wildcard characters: False ``` ### -NumberOfResultsToSkip - -**Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. - Specifies the number of results to skip. -If there are a large number of locations, you can limit the number of returns by using the ResultSize parameter. +If there are a large number of locations, you can limit the number of results by using the ResultSize parameter. If you limited the first cmdlet execution to 25 results, and want to look at the next 25 locations, then you leave ResultSize at 25 and set NumberOfResultsToSkip to 25 to omit the first 25 you've reviewed. For example the command below will return locations 26-50 for Seattle. @@ -318,8 +315,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) -[New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) -[Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) diff --git a/skype/skype-ps/skype/Get-CsOnlineLisPort.md b/teams/teams-ps/teams/Get-CsOnlineLisPort.md similarity index 93% rename from skype/skype-ps/skype/Get-CsOnlineLisPort.md rename to teams/teams-ps/teams/Get-CsOnlineLisPort.md index 1ccb6d723b..190850463c 100644 --- a/skype/skype-ps/skype/Get-CsOnlineLisPort.md +++ b/teams/teams-ps/teams/Get-CsOnlineLisPort.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinelisport +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport applicable: Microsoft Teams title: Get-CsOnlineLisPort schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -167,6 +167,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) -[Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) diff --git a/skype/skype-ps/skype/Get-CsOnlineLisSubnet.md b/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md similarity index 91% rename from skype/skype-ps/skype/Get-CsOnlineLisSubnet.md rename to teams/teams-ps/teams/Get-CsOnlineLisSubnet.md index 1f96f7b376..7aff6725b1 100644 --- a/skype/skype-ps/skype/Get-CsOnlineLisSubnet.md +++ b/teams/teams-ps/teams/Get-CsOnlineLisSubnet.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinelissubnet -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelissubnet +applicable: Microsoft Teams title: Get-CsOnlineLisSubnet schema: 2.0.0 -author: kaishuipinggai +author: serdarsoysal ms.author: serdars ms.reviewer: --- @@ -35,7 +35,6 @@ Get-CsOnlineLisSubnet Example 1 retrieves all Location Information Server (LIS) subnets. - ### -------------------------- Example 2 -------------------------- ``` Get-CsOnlineLisSubnet -Subnet 10.106.89.12 @@ -43,7 +42,6 @@ Get-CsOnlineLisSubnet -Subnet 10.106.89.12 Example 2 retrieves the Location Information Server (LIS) subnet for Subnet ID "10.106.89.12". - ### -------------------------- Example 3 -------------------------- ``` Get-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e @@ -51,7 +49,6 @@ Get-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e Example 2 retrieves the Location Information Server (LIS) subnet for Subnet ID "2001:4898:e8:6c:90d2:28d4:76a4:ec5e". - ## PARAMETERS ### -Force @@ -63,7 +60,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -79,7 +76,7 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -95,7 +92,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -111,7 +108,7 @@ The IP address of the subnet. This value can be either IPv4 or IPv6 format. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 1 @@ -127,7 +124,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -143,7 +140,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -155,24 +152,16 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS - ### System.Guid - ### System.String - ## OUTPUTS - ### System.Object - ## NOTES - ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsOnlineLisSwitch.md b/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md similarity index 92% rename from skype/skype-ps/skype/Get-CsOnlineLisSwitch.md rename to teams/teams-ps/teams/Get-CsOnlineLisSwitch.md index f8e7d0ae45..c5be65a3ec 100644 --- a/skype/skype-ps/skype/Get-CsOnlineLisSwitch.md +++ b/teams/teams-ps/teams/Get-CsOnlineLisSwitch.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinelisswitch +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch applicable: Microsoft Teams title: Get-CsOnlineLisSwitch schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -137,7 +137,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -152,6 +151,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) -[Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) diff --git a/skype/skype-ps/skype/Get-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md similarity index 93% rename from skype/skype-ps/skype/Get-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md index 083e0e791c..a8526f7ab2 100644 --- a/skype/skype-ps/skype/Get-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/teams/Get-CsOnlineLisWirelessAccessPoint.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint applicable: Microsoft Teams title: Get-CsOnlineLisWirelessAccessPoint schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -166,7 +166,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -179,6 +178,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) -[Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) diff --git a/skype/skype-ps/skype/Get-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md similarity index 59% rename from skype/skype-ps/skype/Get-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md index adef6d94be..c7574f56ce 100644 --- a/skype/skype-ps/skype/Get-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinepstngateway -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway +applicable: Microsoft Teams title: Get-CsOnlinePSTNGateway schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,13 +19,12 @@ Shows the configuration of the previously defined Session Border Controller(s) ( ### Identity (Default) ``` -Get-CsOnlinePSTNGateway [-Tenant ] [[-Identity] ] [-LocalStore] - [] +Get-CsOnlinePSTNGateway [[-Identity] ] [] ``` ### Filter ``` -Get-CsOnlinePSTNGateway [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsOnlinePSTNGateway [-Filter ] [] ``` ## DESCRIPTION @@ -42,10 +41,10 @@ This example shows all SBCs paired with the tenant. ### Example 2 ```powershell -PS C:\> Get-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"} +PS C:\> Get-CsOnlinePSTNGateway -Filter "*.contoso.com" ``` -This example selects all SBC with names matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc +This example selects all SBCs with identities matching the pattern *.contoso.com, such as sbc1.contoso.com and sbc2.contoso.com. ## PARAMETERS @@ -55,7 +54,7 @@ This example selects all SBC with names matching the pattern *.contoso.com. For Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -67,10 +66,10 @@ Accept wildcard characters: False The parameter is optional for the cmdlet. If not set all SBCs paired to the tenant are listed. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: 1 Default value: None @@ -78,43 +77,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -123,8 +92,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) -[New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) diff --git a/skype/skype-ps/skype/Get-CsOnlinePstnUsage.md b/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md similarity index 53% rename from skype/skype-ps/skype/Get-CsOnlinePstnUsage.md rename to teams/teams-ps/teams/Get-CsOnlinePstnUsage.md index 7881884520..c70a50caf0 100644 --- a/skype/skype-ps/skype/Get-CsOnlinePstnUsage.md +++ b/teams/teams-ps/teams/Get-CsOnlinePstnUsage.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinepstnusage -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage +applicable: Microsoft Teams title: Get-CsOnlinePstnUsage schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,12 +19,12 @@ Returns information about online public switched telephone network (PSTN) usage ### Identity (Default) ``` -Get-CsOnlinePstnUsage [-Tenant ] [[-Identity] ] [-LocalStore] [] +Get-CsOnlinePstnUsage [[-Identity] ] [] ``` ### Filter ``` -Get-CsOnlinePstnUsage [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsOnlinePstnUsage [-Filter ] [] ``` ## DESCRIPTION @@ -62,7 +62,7 @@ Accept wildcard characters: False The level at which these settings are applied. The only identity that can be applied to PSTN usages is Global. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -73,53 +73,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -127,4 +87,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Set-CsOnlinePstnUsage](https://docs.microsoft.com/powershell/module/skype/set-csonlinepstnusage?view=skype-ps) +[Set-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage) diff --git a/skype/skype-ps/skype/Get-CsOnlineSchedule.md b/teams/teams-ps/teams/Get-CsOnlineSchedule.md similarity index 59% rename from skype/skype-ps/skype/Get-CsOnlineSchedule.md rename to teams/teams-ps/teams/Get-CsOnlineSchedule.md index 6b54620c49..9b0227da05 100644 --- a/skype/skype-ps/skype/Get-CsOnlineSchedule.md +++ b/teams/teams-ps/teams/Get-CsOnlineSchedule.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlineschedule -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule +applicable: Microsoft Teams title: Get-CsOnlineSchedule schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsOnlineSchedule @@ -18,7 +18,7 @@ Use the Get-CsOnlineSchedule cmdlet to get information about schedules that belo ## SYNTAX ``` -Get-CsOnlineSchedule -Id [-Tenant ] [-CommonParameters] +Get-CsOnlineSchedule -Id [] ``` ## DESCRIPTION @@ -49,7 +49,7 @@ The Id for the schedule to be retrieved. If this parameter is not specified, the Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -58,23 +58,8 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Tenant - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -85,13 +70,12 @@ The Get-CsOnlineSchedule cmdlet accepts a string as the Id parameter. ### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule - ## NOTES ## RELATED LINKS -[New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) -[New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) -[New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) diff --git a/skype/skype-ps/skype/Get-CsOnlineSipDomain.md b/teams/teams-ps/teams/Get-CsOnlineSipDomain.md similarity index 76% rename from skype/skype-ps/skype/Get-CsOnlineSipDomain.md rename to teams/teams-ps/teams/Get-CsOnlineSipDomain.md index c480acf9c3..0627f86a2a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineSipDomain.md +++ b/teams/teams-ps/teams/Get-CsOnlineSipDomain.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinesipdomain -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinesipdomain +applicable: Microsoft Teams title: Get-CsOnlineSipDomain schema: 2.0.0 manager: bulenteg @@ -13,7 +13,7 @@ ms.reviewer: rogupta # Get-CsOnlineSipDomain ## SYNOPSIS -This cmdlet lists online sip domains and their enabled/disabled status. In a disabled domain, provisioning of users is blocked. Once a domain is re-enabled, provisioning of users in that domain will happen. +This cmdlet lists online sip domains and their enabled/disabled status. In a disabled domain, provisioning of users is blocked. Once a domain is re-enabled, provisioning of users in that domain will happen. ## SYNTAX @@ -22,7 +22,7 @@ Get-CsOnlineSipDomain [-Domain ] [-DomainStatus ] [ Get-CsOnlineTelephoneNumberCountry [] ``` ## DESCRIPTION -Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberCountry` cmdlet to get the list of supported countries or regions to search and acquire new telephone numbers. The telephone numbers can then be used to set up calling features for users and services in your organization. ## EXAMPLES @@ -50,15 +50,20 @@ This example returns the list of supported countries or regions for the cmdlet s ## 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 -[Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) -[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) \ No newline at end of file +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md index dd8336685b..5725171ad6 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder Module Name: MicrosoftTeams title: Get-CsOnlineTelephoneNumberOrder schema: 2.0.0 @@ -13,89 +13,161 @@ ms.reviewer: julienp # Get-CsOnlineTelephoneNumberOrder ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number order. ## SYNTAX ``` -Get-CsOnlineTelephoneNumberOrder [-OrderId] [] +Get-CsOnlineTelephoneNumberOrder -OrderId [-OrderType ] + [] ``` ## DESCRIPTION -Use the `Get-CsOnlineTelephoneNumberOrder` cmdlet to get the order report of a specific telephone number search order. The telephone numbers can then be used to set up calling features for users and services in your organization. - +This `Get-CsOnlineTelephoneNumberOrder` cmdlet can be used to get the status of specific telephone number orders. Currently supported orders for retrievals are: Search [New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder), Direct Routing Number Upload [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder), and Direct Routing Number Release [New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder). When the OrderType is not indicated, the cmdlet will default to a Search order. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 5:43:44 PM -Description : test -ErrorCode : NoError -Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 -InventoryType : Subscriber -IsManual : False -Name : test -NumberPrefix : 1718 -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : 8/23/2021 5:59:45 PM -SearchType : Prefix -SendToServiceDesk : False -Status : Reserved -TelephoneNumber : {Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TelephoneNumberSearchResult} - -PS C:\> $order.TelephoneNumber - -Location TelephoneNumber --------- --------------- -New York City +17182000004 +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderType Search -OrderId 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be + +Key Value +--- ----- +Id 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be +Name Postal Code Search Test +CreatedAt 2024-11-30T00:34:00.0825627+00:00 +CreatedBy ContosoAdmin +Description Postal Code Search Test +NumberType UserSubscriber +SearchType PostalCode +AreaCode 778 +PostalOrZipCode V7Y 1G5 +Quantity 2 +Status Reserved +IsManual False +TelephoneNumbers {System.Collections.Generic.Dictionary`2[System.String,System.Object], System.Collections.Generic.Dictionary`2[System.String,System.Object]} +ReservationExpiryDate 2024-11-30T00:50:01.1794152+00:00 +ErrorCode NoError +InventoryType Subscriber +SendToServiceDesk False +CountryCode CA + +PS C:\> $order.TelephoneNumbers + +Key Value +--- ----- +Location Vancouver +TelephoneNumber +16046606034 +Location Vancouver +TelephoneNumber +16046606030 ``` -This example returns a successful telephone number search and the telephone number +17182000004 is reserved for purchase. +This example returns a successful telephone number search and the telephone numbers are reserved for purchase. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` -PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042 - -AreaCode : -CivicAddressId : -CountryCode : US -CreatedAt : 8/23/2021 6:53:12 PM -Description : test -ErrorCode : OutOfStock -Id : 8d23e073-bc98-4f73-8e05-7517655d7042 -InventoryType : Subscriber -IsManual : False -Name : test -NumberPrefix : 1425 -NumberType : UserSubscriber -Quantity : 1 -ReservationExpiryDate : -SearchType : Prefix -SendToServiceDesk : False -Status : Error -TelephoneNumber : {} +PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderType Search -OrderId 8d23e073-bc98-4f73-8e05-7517655d7042 + +Key Value +--- ----- +Id 8d23e073-bc98-4f73-8e05-7517655d7042 +Name Postal Code Search Test +CreatedAt 2024-11-30T00:34:00.0825627+00:00 +CreatedBy ContosoAdmin +Description Prefix Search Test +NumberType UserSubscriber +SearchType Prefix +AreaCode +PostalOrZipCode +Quantity 1 +Status Error +IsManual False +TelephoneNumbers {} +ReservationExpiryDate +ErrorCode OutOfStock +InventoryType Subscriber +SendToServiceDesk False +CountryCode ``` This example returns a failed telephone number search and the `ErrorCode` is showing that telephone numbers with `NumberPrefix: 1425` is `OutOfStock`. +### Example 3 +```powershell +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderId 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be + +Key Value +--- ----- +Id 1fd52b3b-b804-4ac4-a84d-4d70b51dd4be +Name Postal Code Search Test +CreatedAt 2024-11-30T00:34:00.0825627+00:00 +CreatedBy TNM +Description Postal Code Search Test from Postman +NumberType UserSubscriber +SearchType PostalCode +AreaCode 778 +PostalOrZipCode V7Y 1G5 +Quantity 2 +Status Expired +IsManual False +TelephoneNumbers {System.Collections.Generic.Dictionary`2[System.String,System.Object], System.Collections.Generic.Dictionary`2[System.String,System.Object]} +ReservationExpiryDate 2024-11-30T00:50:01.1794152+00:00 +ErrorCode NoError +InventoryType Subscriber +SendToServiceDesk False +CountryCode CA +``` + +When the OrderType is not indicated, the cmdlet will default to a Search order. This example returns a successful telephone number search and the telephone numbers are reserved for purchase. + +### Example 4 +```powershell +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId 6aa4f786-8628-4923-9df1-896f3d84016c + +Key Value +--- ----- +OrderId 6aa4f786-8628-4923-9df1-896f3d84016c +CreatedAt 2024-11-27T06:44:26.1975766+00:00 +Status Complete +TotalCount 3 +SuccessCount 3 +FailureCount 0 +SuccessPhoneNumbers {+12063866355, +12063868075, +12063861642} +FailedPhoneNumbers {} +``` + +This example returns the status of a successful release order for Direct Routing telephone numbers. + +### Example 5 +```powershell +PS C:\> Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId faef09f7-5bd5-4740-9e76-9a5762380f34 + +Key Value +--- ----- +OrderId faef09f7-5bd5-4740-9e76-9a5762380f34 +CreatedAt 2024-11-30T00:22:59.4989508+00:00 +Status Success +TotalCount 1 +SuccessCount 1 +FailureCount 0 +WarningCount 0 +FailedPhoneNumbers {} +WarningPhoneNumbers {} +SuccessPhoneNumbers {+99999980} +``` + +This example returns the status of a successful upload order for a Direct Routing phone number. ## PARAMETERS -### OrderId -Specifies the telephone number search order to look up. Use `New-CsOnlineTelephoneNumberOrder` to create a search order to obtain a search order Id. +### -OrderId +Use the OrderId received as output of your order creation cmdlets. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -104,16 +176,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OrderType +Specifies the type of telephone number order to look up. Currently supported values are **Search**, **Release**, and **DirectRoutingNumberCreation**. If this value is unspecified, then it will default to a **Search** order. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS -## RELATED LINKS +## NOTES +Updates in Teams PowerShell Module version 6.7.1 and later: +- A new optional parameter `OrderType` is introduced. If no OrderType is provided, it will default to a Search order. +- [BREAKING CHANGE] When a Search order is queried, the property name `TelephoneNumber` in the output will be changed to `TelephoneNumbers`. The structure of the `TelephoneNumbers` output will remain unchanged. + - Impact: Scripts and processes that reference the `TelephoneNumber` property will need to be updated to use `TelephoneNumbers`. -[Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) - -[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) \ No newline at end of file +## RELATED LINKS +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) +[New-CsOnlineTelephoneNumberReleaseOrder](https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md index e080a2dd28..47c397e14b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype Module Name: MicrosoftTeams title: Get-CsOnlineTelephoneNumberType schema: 2.0.0 @@ -13,7 +13,7 @@ ms.reviewer: julienp # Get-CsOnlineTelephoneNumberType ## SYNOPSIS -Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country. The telephone numbers can then be used to set up calling features for users and services in your organization. +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. The telephone numbers can then be used to set up calling features for users and services in your organization. ## SYNTAX @@ -23,8 +23,7 @@ Get-CsOnlineTelephoneNumberType [-Country] [] ## DESCRIPTION -Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country. The `NumberType` field in the response is used to indicate the capabilities of a given offering. The telephone numbers can then be used to set up calling features for users and services in your organization. - +Use the `Get-CsOnlineTelephoneNumberType` cmdlet to get the list of supported telephone number offerings in a given country or region. The `NumberType` field in the response is used to indicate the capabilities of a given offering. The telephone numbers can then be used to set up calling features for users and services in your organization. ## EXAMPLES @@ -74,16 +73,15 @@ AutoAttendantTollFree ``` This example returns the list of supported NumberTypes in Canada. - ## PARAMETERS ### Country -Specifies the country that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries can be found by calling `Get-CsOnlineTelephoneNumberCountry`. +Specifies the country or region that the number offerings belong. The country code uses ISO 3166 standard and the list of supported countries or regions can be found by calling `Get-CsOnlineTelephoneNumberCountry`. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -92,16 +90,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) \ No newline at end of file +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/Get-CsOnlineUser.md b/teams/teams-ps/teams/Get-CsOnlineUser.md new file mode 100644 index 0000000000..4a4e832276 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineUser.md @@ -0,0 +1,580 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser +applicable: Microsoft Teams +title: Get-CsOnlineUser +schema: 2.0.0 +manager: sshastri +author: praspatil +ms.author: praspatil +ms.reviewer: +--- + +# Get-CsOnlineUser + +## SYNOPSIS +Returns information about users who have accounts homed on Microsoft Teams or Skype for Business Online. + +## SYNTAX + +``` +Get-CsOnlineUser [[-Identity] ] + [-AccountType ] + [-Filter ] + [-Properties ] + [-ResultSize ] + [-SkipUserPolicies] + [-SoftDeletedUser] + [-Sort] + [] +``` + +## DESCRIPTION +The Get-CsOnlineUser cmdlet returns information about users who have accounts homed on Microsoft Teams +The returned information includes standard Active Directory account information (such as the department the user works in, his or her address and phone number, etc.): the Get-CsOnlineUser cmdlet returns information about such things as whether or not the user has been enabled for Enterprise Voice and which per-user policies (if any) have been assigned to the user. + +Note that the Get-CsOnlineUser cmdlet does not have a TenantId parameter; that means you cannot use a command similar to this in order to limit the returned data to users who have accounts with a specific Microsoft Teams or Skype for Business Online tenant: + +`Get-CsOnlineUser -TenantId "bf19b7db-6960-41e5-a139-2aa373474354"` + +However, if you have multiple tenants you can return users from a specified tenant by using the Filter parameter and a command similar to this: + +`Get-CsOnlineUser -Filter "TenantId -eq 'bf19b7db-6960-41e5-a139-2aa373474354'"` + +That command will limit the returned data to user accounts belong to the tenant with the TenantId "bf19b7db-6960-41e5-a139-2aa373474354". +If you do not know your tenant IDs you can return that information by using this command: + +`Get-CsTenant` + +If you have a hybrid or "split domain" deployment (that is, a deployment in which some users have accounts homed on Skype for Business Online while other users have accounts homed on an on-premises version of Skype for Business Server 2015) keep in mind that the Get-CsOnlineUser cmdlet only returns information for Skype for Business Online users. +However, the cmdlet will return information for both online users and on-premises users. +If you want to exclude Skype for Business Online users from the data returned by the Get-CsUser cmdlet, use the following command: + +`Get-CsUser -Filter "TenantId -eq '00000000-0000-0000-0000-000000000000'"` + +By definition, users homed on the on-premises version will always have a TenantId equal to 00000000-0000-0000-0000-000000000000. +Users homed on Skype for Business Online will a TenantId that is equal to some value other than 00000000-0000-0000-0000-000000000000. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsOnlineUser +``` + +The command shown in Example 1 returns information for all the users configured as online users. + +### -------------------------- Example 2 -------------------------- +``` +Get-CsOnlineUser -Identity "sip:kenmyer@litwareinc.com" +``` + +In Example 2 information is returned for a single online user: the user with the SIP address "sip:kenmyer@litwareinc.com". + +### -------------------------- Example 3 -------------------------- +``` +Get-CsOnlineUser -Filter "ArchivingPolicy -eq 'RedmondArchiving'" +``` + +Example 3 uses the Filter parameter to limit the returned data to online users who have been assigned the per-user archiving policy RedmondArchiving. + +To do this, the filter value {ArchivingPolicy -eq "RedmondArchiving"} is employed; that syntax limits returned data to users where the ArchivingPolicy property is equal to (-eq) "RedmondArchiving". + +### -------------------------- Example 4 -------------------------- +``` +Get-CsOnlineUser -Filter {HideFromAddressLists -eq $True} +``` + +Example 4 returns information only for user accounts that have been configured so that the account does not appear in Microsoft Exchange address lists. + +(That is, the Active Directory attribute msExchHideFromAddressLists is True.) To carry out this task, the Filter parameter is included along with the filter value {HideFromAddressLists -eq $True}. + +### -------------------------- Example 5 -------------------------- +``` +Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234"} +Get-CsOnlineUser -Filter {LineURI -eq "tel:+1234,ext:"} +Get-CsOnlineUser -Filter {LineURI -eq "1234"} +``` + +Example 5 returns information for user accounts that have been assigned a designated phone number. + +### -------------------------- Example 6 -------------------------- +``` +Get-CsOnlineUser -AccountType ResourceAccount +``` + +Example 6 returns information for user accounts that are categorized as resource accounts. + +### -------------------------- Example 7 -------------------------- +``` +Get-CsOnlineUser -Filter "FeatureTypes -Contains 'PhoneSystem'" +``` + +Example 7 returns information for user's assigned plans. + +## PARAMETERS + +### -AccountType +This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate the user type. The possible values for the AccountType parameter are: + +- `User` - to query for user accounts. +- `ResourceAccount` - to query for app endpoints or resource accounts. +- `Guest` - to query for guest accounts. +- `SfBOnPremUser` - to query for users that are hosted on-premises +- `IneligibleUser` - to query for a user that does not have valid Teams license (except Guest, ResourceAccount and SfbOnPremUser). + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account to be retrieved. + +For TeamsOnly customers using the Teams PowerShell Module version 3.0.0 or later, you use the following values to identify the account: + +- GUID +- SIP address +- UPN +- Alias + +Using the Teams PowerShell Module version 2.6 or earlier only, you can use the following values to identify the account: + +- GUID +- SIP address +- UPN +- Alias +- Display name. Supports the asterisk ( \* ) wildcard character. For example, `-Identity "* Smith"` returns all the users whose display names end with Smith. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to limit the returned data by filtering on specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. + +The Filter parameter uses the same filtering syntax as the Where-Object cmdlet. For example, the following filter returns only users who have been enabled for Enterprise Voice: `-Filter 'EnterpriseVoiceEnabled -eq $True'` or ``-Filter "EnterpriseVoiceEnabled -eq `$True"``. + +Examples: +- Get-CsOnlineUser -Filter {AssignedPlan -like "*MCO*"} +- Get-CsOnlineUser -Filter {UserPrincipalName -like "test*" -and (AssignedPlans -eq "MCOEV" -or AssignedPlans -like "MCOPSTN*")} +- Get-CsOnlineUser -Filter {OnPremHostingProvider -ne $null} +- Get-CsOnlineUser -Filter {WhenChanged -gt "1/25/2022 11:59:59 PM"} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Properties + +Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Identity, UserPrincipalName, Alias, AccountEnabled and DisplayName attributes will always be present in the output. Please note that only attributes available in the output of the Get-CsOnlineUser cmdlet can be selected. For a complete list of available attributes, refer to the response of the Get-CsOnlineUser cmdlet. + +Examples: +- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes +- Get-CsOnlineUser -Properties DisplayName, Alias, LineURI + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize + +**Note**: Starting with Teams PowerShell Modules version 4.0 and later, "-ResultSize" type has been changed to uint32. + +Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. + +The result size can be set to any whole number between 0 and 2147483647, inclusive. The value 0 returns no data. If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipUserPolicies +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedUser + +This parameter enables you to return a collection of all the users who are deleted and can be restored within 30 days from their deletion time + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sort + +Sorting is now enabled in Teams PowerShell Module by using the "-Sort" or "-OrderBy" parameters. For example: + +- Get-CsOnlineUser -Filter {LineURI -like *123*} -OrderBy "DisplayName asc" +- Get-CsOnlineUser -Filter {DisplayName -like '*abc'} -OrderBy {DisplayName desc} + +**Note**: Sorting on few attributes like LineURI can be case-sensitive. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: OrderBy +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +A recent fix has addressed an issue where some Guest users were being omitted from the output of the Get-CsOnlineUser cmdlet, resulting in an increase in the reported user count. + +**Commonly used FeatureTypes and their descriptions:** + +- Teams: Enables Users to access Teams +- AudioConferencing': Enables users to call-in to Teams meetings from their phones +- PhoneSystem: Enables users to place, receive, transfer, mute, unmute calls in Teams with mobile device, PC, or IP Phones +- CallingPlan: Enables an All-in-the-cloud voice solution for Teams users that connects Teams Phone System to the PSTN to enable external calling. With this option, Microsoft acts as the PSTN carrier. +- TeamsMultiGeo: Enables Teams chat data to be stored at rest in a specified geo location +- VoiceApp: Enables to set up resource accounts to support voice applications like Auto Attendants and Call Queues +- M365CopilotTeams: Enables Copilot in Teams +- TeamsProMgmt: Enables enhanced meeting recap features like AI generated notes and tasks from meetings, view when a screen was shared etc +- TeamsProProtection: Enables additional ways to safeguard and monitor users' Teams experiences with features like Sensitivity labels, Watermarking, end-to-end encryption etc. +- TeamsProWebinar: Enables advances webinar features like engagement reports, RTMP-In, Webinar Wait List, in Teams. +- TeamsProCust: Enables meeting customization features like branded meetings, together mode, in Teams. +- TeamsProVirtualAppt: Enables advances virtual appointment features like SMS notifications, custom waiting room, in Teams. +- TeamsRoomPro: Enables premium in-room meeting experience like intelligent audio, large galleries in Teams. +- TeamsRoomBasic: Enables core meeting experience with Teams Rooms Systems. +- TeamsAdvComms: Enables advances communication management like custom communication policies in Teams. +- TeamsMobileExperience: Enables users to use a single phone number in Teams across both sim-enabled mobile phone and desk lines. +- Conferencing_RequiresCommunicationCredits: Allows pay-per minute Audio Conferencing without monthly licenses. +- CommunicationCredits: Enables users to pay Teams calling and conferencing through the credits. + +**Updates in Teams PowerShell Module version 7.0.0 and later**: + +- OptionFlags: OptionFlags attribute will no longer be populated with value in the output of Get-CsOnlineUser in all clouds. It's important to note that other details besides EnterpriseVoiceEnabled, previously found in OptionFlags, are no longer relevant for Teams. Administrators can still utilize the EnterpriseVoiceEnabled attribute in the output of the Get-CsOnlineUser cmdlet to get this information. This change will be rolled out to all Teams Powershell Module versions. + +**Updates in Teams PowerShell Module version 6.9.0 and later**: + +Adds new attribute in the output of Get-CsOnlineUser cmdlet in commercial environments. + - TelephoneNumbers: A new list of complex object that includes telephone number and its corresponding assignment category. The assignment category can include values such as 'Primary', 'Private', and 'Alternate'. + +Adds new parameter to the Get-CsOnlineUser cmdlet in all clouds: + - Properties: Allows you to specify the properties you want to include in the output. Provide the properties as a comma-separated list. Note that the following properties will always be present in the output: Identity, UserPrincipalName, Alias, AccountEnabled, DisplayName. + +**Updates in Teams PowerShell Module version 6.8.0 and later**: + +New policies - TeamsBYODAndDesksPolicy, TeamsAIPolicy, TeamsWorkLocationDetectionPolicy, TeamsMediaConnectivityPolicy, TeamsMeetingTemplatePermissionPolicy, TeamsVirtualAppointmentsPolicy and TeamsWorkLoadPolicy will be visible in the Get-CsOnlineUser cmdlet output. + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 6.8.0 or later for Microsoft Teams operated by 21Vianet. These updates will be rolled out gradually to older Microsoft Teams PowerShell versions. + +The following attributes are populated with correct values in the output of Get-CsOnlineUser when not using the "-identity" parameter: + +- CountryAbbreviation +- UserValidationErrors +- WhenCreated + +The following updates are applicable to the output in scenarios where "-identity" parameter is not used: + +- Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. +- Guest are available in the output +- Unlicensed Users: Unlicensed users would show up in the output of Get-CsOnlineUser (note Unlicensed users in commercial clouds would show up in the output for only 30 days post-license removal.) +- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. +- AccountType as Unknown will be renamed to AccountType as IneligibleUser in GCC High and DoD environments. IneligibleUser will include users who do not have any valid Teams licenses (except Guest, SfbOnPremUser, ResourceAccount). + +If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. + +If Guest, Soft Deleted Users, IneligibleUser are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp. For example: + +- Get-CsOnlineUser -Filter {AccountType -ne 'Guest'} +- Get-CsOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +- Get-CsOnlineUser -Filter {AccountType -ne 'IneligibleUser'} + +**Updates in Teams PowerShell Module version 6.1.1 Preview and later**: + +The following updates are applicable for organizations that use Microsoft Teams PowerShell version 6.1.1 (Targeted Release: April 15th, 2024) or later. These changes will be gradually rolled out for all tenants starting from April 26th, 2024. + +When using the Get-CsOnlineUser cmdlet in Teams PowerShell Module without the -identity parameter, we are introducing these updates: + +- Before the rollout, unlicensed users who did not have a valid Teams license were displayed in the output of the Get-CsOnlineUser cmdlet for 30 days after license removal. After the rollout, Get-CsOnlineUser will show unlicensed users after the initial 30 days and also include unlicensed users who never had a valid Teams license. +- The AccountType value Unknown is being renamed to IneligibleUser, and will include users who do not have a valid Teams license (exceptions: Guest, SfbOnPremUser, and ResourceAccount). +- You can exclude users with the AccountType as IneligibleUser from the output with the AccountType filter. For example, Get-CsOnlineUser -Filter {AccountType -ne 'IneligibleUser'} + +When Get-CsOnlineUser is used with the -identity parameter, you can also use UPN, Alias, and SIP Address with the -identity parameter to obtain the information for a specific unlicensed user. + +**Updates in Teams PowerShell Module version 6.1.0 and later**: + +The following updates are applicable for organizations that use Microsoft Teams PowerShell version 6.1.0 or later. + +- LocationPolicy: LocationPolicy attribute is being deprecated from the output of Get-CsOnlineUser in all clouds. Get-CsPhoneNumberAssignment -IsoCountryCode can be used to get the LocationPolicy information. (Note: LocationPolicy attribute will no longer be populated with value in the older Teams Powershell Module versions (<6.1.0) starting from 20th March 2024.) + +**Updates in Teams PowerShell Module version 6.0.0 and later**: + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 6.0.0 or later. + +- GracePeriodExpiryDate: GracePeriodExpiryDate attribute is being introduced within the AssignedPlan JSON array. It specifies the date when the grace period of a previously deleted license expires, and the license will be permanently deleted. The attribute remains empty/null for active licenses. (Note: The attribute is currently in private preview and will display valid values only for private preview) + +- IsInGracePeriod: IsInGracePeriod attribute is a boolean flag that indicates that the associated plan is in grace period after deletion. (Note: The attribute is currently in private preview and will display valid values only for private preview) + +**Updates in Teams PowerShell Module version 5.9.0 and later**: + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.9.0 or later in GCC High and DoD environments (note that these changes are already rolled out in commercial environments). These updates will be applicable to older Teams PowerShell versions from 15th March 2024 in GCC High and DoD environments: + +The following attributes are populated with correct values in the output of Get-CsOnlineUser when not using the "-identity" parameter: + +- CountryAbbreviation +- UserValidationErrors +- WhenCreated + +The following updates are applicable to the output in scenarios where "-identity" parameter is not used: + +- Only valid OnPrem users would be available in the output: These are users that are DirSyncEnabled and have a valid OnPremSipAddress or SIP address in ShadowProxyAddresses. +- Guest are available in the output +- Unlicensed Users: Unlicensed users would show up in the output of Get-CsOnlineUser (note Unlicensed users in commercial clouds would show up in the output for only 30 days post-license removal.) +- Soft deleted users: These users will be displayed in the output of Get-CsOnlineUser and the TAC Manage Users page by default with SoftDeletionTimestamp set to a value. +- AccountType as Unknown will be renamed to AccountType as IneligibleUser in GCC High and DoD environments. IneligibleUser will include users who do not have any valid Teams licenses (except Guest, SfbOnPremUser, ResourceAccount). + +If any information is required for a user that is not available in the output (when not using "-identity" parameter) then it can be obtained using the "-identity" parameter. Information for all users would be available using the "-identity" parameter until they are hard deleted. + +If Guest, Soft Deleted Users, IneligibleUser are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp. For example: + +- Get-CsOnlineUser -Filter {AccountType -ne 'Guest'} +- Get-CsOnlineUser -Filter {SoftDeletionTimestamp -eq $null} +- Get-CsOnlineUser -Filter {AccountType -ne 'IneligibleUser'} + +**Updates in Teams PowerShell Module version 3.0.0 and above**: + +The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 3.0.0 and later, excluding updates mentioned previously for Teams PowerShell Module version 5.0.0: + +_New user attributes_: + +FeatureTypes: Array of unique strings specifying what features are enabled for a user. This attribute is an alternative to several attributes that have been dropped as outlined in the next section. + +Some of the commonly used FeatureTypes include: + +- Teams +- AudioConferencing +- PhoneSystem +- CallingPlan + +**Note**: This attribute is now filterable in Teams PowerShell Module versions 4.0.0 and later using the "-Contains" operator as shown in Example 7. + +AccountEnabled: Indicates whether a user is enabled for login in Microsoft Entra ID. + +_Dropped attributes_: + +The following attributes are no longer relevant to Teams and have been dropped from the output: + +- AcpInfo +- AdminDescription +- ArchivingPolicy +- AudioVideoDisabled +- BaseSimpleUrl +- BroadcastMeetingPolicy +- CallViaWorkPolicy +- ClientPolicy +- ClientUpdateOverridePolicy +- ClientVersionPolicy +- CloudMeetingOpsPolicy +- CloudMeetingPolicy +- CloudVideoInteropPolicy +- ContactOptionFlags +- CountryOrRegionDisplayName +- Description +- DistinguishedName +- EnabledForRichPresence +- ExchangeArchivingPolicy +- ExchUserHoldPolicies +- ExperiencePolicy +- ExternalUserCommunicationPolicy +- ExUmEnabled +- Guid +- HomeServer +- HostedVoicemailPolicy +- IPPBXSoftPhoneRoutingEnabled +- IPPhone +- IPPhonePolicy +- IsByPassValidation +- IsValid +- LegalInterceptPolicy +- LicenseRemovalTimestamp +- LineServerURI +- Manager +- MNCReady +- Name +- NonPrimaryResource +- ObjectCategory +- ObjectClass +- ObjectState +- OnPremHideFromAddressLists +- OriginalPreferredDataLocation +- OriginatingServer +- OriginatorSid +- OverridePreferredDataLocation +- PendingDeletion +- PrivateLine +- ProvisioningCounter +- ProvisioningStamp +- PublishingCounter +- PublishingStamp +- Puid +- RemoteCallControlTelephonyEnabled +- RemoteMachine +- SamAccountName +- ServiceInfo +- StsRefreshTokensValidFrom +- SubProvisioningCounter +- SubProvisioningStamp +- SubProvisionLineType +- SyncingCounter +- TargetRegistrarPool +- TargetServerIfMoving +- TeamsInteropPolicy +- ThumbnailPhoto +- UpgradeRetryCounter +- UserAccountControl +- UserProvisionType +- UserRoutingGroupId +- VoicePolicy - Alternative is the CallingPlan and PhoneSystem string in FeatureTypes +- XForestMovePolicy +- AddressBookPolicy +- GraphPolicy +- PinPolicy +- PreferredDataLocationOverwritePolicy +- PresencePolicy +- SmsServicePolicy +- TeamsVoiceRoute +- ThirdPartyVideoSystemPolicy +- UserServicesPolicy +- ConferencingPolicy +- Id +- MobilityPolicy +- OnlineDialinConferencingPolicy - Alternative is the AudioConferencing string in FeatureTypes +- Sid +- TeamsWorkLoadPolicy +- VoiceRoutingPolicy +- ClientUpdatePolicy +- HomePhone +- HostedVoiceMail +- MobilePhone +- OtherTelephone +- StreetAddress +- WebPage +- AssignedLicenses +- OnPremisesUserPrincipalName +- HostedVoiceMail +- LicenseAssignmentStates +- OnPremDomainName +- OnPremSecurityIdentifier +- OnPremSamAccountName +- CallerIdPolicy +- Fax +- LastName (available in Teams PowerShell Module 4.2.1 and later) +- Office +- Phone +- WindowsEmailAddress +- SoftDeletedUsers (available in Teams PowerShell Module 4.4.3 and later) + +The following attributes are temporarily unavailable in the output when using the "-Filter" or when used without the "-Identity" parameter: + +- WhenChanged +- CountryAbbreviation + +**Note**: These attributes will be available in the near future. + +_Attributes renamed_: + +- ObjectId renamed to Identity +- FirstName renamed to GivenName +- DirSyncEnabled renamed to UserDirSyncEnabled +- MCOValidationErrors renamed to UserValidationErrors +- Enabled renamed to IsSipEnabled +- TeamsBranchSurvivabilityPolicy renamed to TeamsSurvivableBranchAppliancePolicy +- CountryOrRegionDisplayName introduced as Country (in versions 4.2.0 and later) +- InterpretedUserType: "AADConnectEnabledOnline" prefix for the InterpretedUserType output value has now been renamed DirSyncEnabledOnline, for example, AADConnectEnabledOnlineTeamsOnlyUser is now DirSyncEnabledOnlineTeamsOnlyUser. + +_Attributes that have changed in meaning/format_: + +**OnPremLineURI**: This attribute previously used to refer to both: + +1. LineURI set via OnPrem AD. +2. Direct Routing numbers assigned to users via Set-CsUser. + +In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the LineURI set via OnPrem AD. Direct Routing numbers will be available from the LineURI field. Direct Routing Numbers can be distinguished from Calling Plan Numbers by looking at the FeatureTypes attribute. + +- **The output format of AssignedPlan and ProvisionedPlan have now changed from XML to JSON array.** +- **The output format of Policies has now changed from String to JSON type UserPolicyDefinition.** + +## RELATED LINKS + +[Set-CsUser](https://learn.microsoft.com/powershell/module/teams/set-csuser) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md similarity index 64% rename from skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md index 1a7c83c557..530da92267 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroute -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute +applicable: Microsoft Teams title: Get-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,19 +19,18 @@ Returns information about the online voice routes configured for use in your ten ### Identity (Default) ``` -Get-CsOnlineVoiceRoute [-Tenant ] [[-Identity] ] [-LocalStore] - [] +Get-CsOnlineVoiceRoute [[-Identity] ] [] ``` ### Filter ``` -Get-CsOnlineVoiceRoute [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsOnlineVoiceRoute [-Filter ] [] ``` ## DESCRIPTION Use this cmdlet to retrieve one or more existing online voice routes in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX). -This cmdlet can be used to retrieve voice route information such as which online PSTN gateways the route is associated with (if any), which online PSTN usages are associated with the route, the pattern (in the form of a regular expression) that identifies the phone numbers to which the route applies, and caller ID settings. The PSTN usage associates the voice route to a online voice policy. +This cmdlet can be used to retrieve voice route information such as which online PSTN gateways the route is associated with (if any), which online PSTN usages are associated with the route, the pattern (in the form of a regular expression) that identifies the phone numbers to which the route applies, and caller ID settings. The PSTN usage associates the voice route to an online voice policy. This cmdlet is used when configuring Microsoft Phone System Direct Routing. @@ -86,7 +85,7 @@ Accept wildcard characters: False A string that uniquely identifies the voice route. If no identity is provided, all voice routes for the organization are returned. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: @@ -97,53 +96,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is reserved for internal Microsoft use - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -151,8 +110,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md similarity index 68% rename from skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md index 0bc462835b..1aec9c2d0a 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroutingpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy +applicable: Microsoft Teams title: Get-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,12 +19,12 @@ Returns information about the online voice routing policies configured for use i ### Identity (Default) ``` -Get-CsOnlineVoiceRoutingPolicy [-Tenant ] [[-Identity] ] [-LocalStore] [] +Get-CsOnlineVoiceRoutingPolicy [[-Identity] ] [] ``` ### Filter ``` -Get-CsOnlineVoiceRoutingPolicy [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsOnlineVoiceRoutingPolicy [-Filter ] [] ``` ## DESCRIPTION @@ -102,7 +102,7 @@ You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then `Get-CsOnlineVoiceRoutingPolicy` returns all the voice routing policies configured for use in the tenant. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -113,53 +113,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policies are being queried. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -167,10 +127,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md b/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md similarity index 56% rename from skype/skype-ps/skype/Get-CsOnlineVoiceUser.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceUser.md index e84d9fd5be..71f7ff2efb 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoiceUser.md +++ b/teams/teams-ps/teams/Get-CsOnlineVoiceUser.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceuser -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceuser +applicable: Microsoft Teams title: Get-CsOnlineVoiceUser schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -23,11 +23,43 @@ Get-CsOnlineVoiceUser [-CivicAddressId ] [-DomainController < ``` ## DESCRIPTION -In Teams PowerShell Module version 3.0 and later, the following improvements have been introduced for organizations using Teams: + +**Note**: This cmdlet **is no longer supported** on the public and GCC cloud instances. You should use the replacement cmdlets described here. + +The following table lists the parameters to `Get-CsOnlineVoiceUser` and the alternative method of getting the same data using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, `Get-CsOnlineLisLocation`, and `Get-CsOnlineLisCivicAddress`. + +| Parameter | Description | Alternative | +| :------------| :------- | :------- | +| No parameters | Get information for all users | `Get-CsOnlineUser -Filter {(FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| CivicAddressId | Find phone number information where the assigned phone number is associated with the CivicAddressId | `Get-CsPhoneNumberAssignment -CivicAddressId ` | +| EnterpriseVoiceStatus | Find enabled users based on EnterpriseVoiceEnabled | `Get-CsOnlineUser -Filter {(EnterpriseVoiceEnabled -eq $True) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` or `Get-CsOnlineUser -Filter {(EnterpriseVoiceEnabled -eq $False) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| ExpandLocation | Show information about the LocationId | `Get-CsOnlineLisLocation -LocationId ` | +| Identity | Get information for a user | `Get-CsOnlineUser -Identity ` | +| LocationId | Find phone number information where the assigned phone number is associated with the LocationId | `Get-CsPhoneNumberAssignment -LocationId ` | +| NumberAssigned | Find enabled users with a phone number assigned | `Get-CsOnlineUser -Filter {(LineUri -ne $Null) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| NumberNotAssigned | Find users without a phone number assigned | `Get-CsOnlineUser -Filter {(LineUri -eq $Null) -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | +| PSTNConnectivity | Find enabled users with PhoneSystem (OnPremises) or CallingPlan (Online) | Online: `Get-CsOnlineUser -Filter {(FeatureTypes -contains 'CallingPlan') -and (AccountEnabled -eq $True)} -AccountType User` OnPremises: `Get-CsOnlineUser -Filter {-not (FeatureTypes -contains 'CallingPlan') -and (FeatureTypes -contains 'PhoneSystem') -and (AccountEnabled -eq $True)} -AccountType User` | + +The following table lists the output fields from `Get-CsOnlineVoiceUser` and the alternative method of getting the same information using a combination of `Get-CsOnlineUser`, `Get-CsPhoneNumberAssignment`, and `Get-CsOnlineLisLocation`. + +| Output field | Alternative | +| :---------------------------------| :--------------------------------- | +| Name | DisplayName in the output from `Get-CsOnlineUser` | +| Id | Identity in the output from `Get-CsOnlineUser`| +| SipDomain | Extract SipDomain from the SipAddress in the output from `Get-CsOnlineUser` | +| DataCenter | Extract DataCenter from RegistrarPool in the output from `Get-CsOnlineUser`| +| TenantId | TenantId in the output from `Get-CsOnlineUser`| +| PstnConnectivity | FeatureTypes in the output from `Get-CsOnlineUser`. If FeatureTypes contains `CallingPlan`, PstnConnectivity is `Online`. If FeatureTypes contains `PhoneSystem` and does not contain `CallingPlan`, PstnConnectivity is `OnPremises` | +| UsageLocation | UsageLocation in the output from `Get-CsOnlineUser` | +| EnterpriseVoiceEnabled | EnterpriseVoiceEnabled in the output from `Get-CsOnlineUser` | +| Number | LineUri in the output from `Get-CsOnlineUser`. You can get same phone number format by doing LineUri.Replace('tel:+','') | +| Location | Use LocationId in the output from `Get-CsPhoneNumberAssignment -AssignedPstnTargetId ` as the input to `Get-CsOnlineLisLocation -LocationId` | + +In Teams PowerShell Module version 3.0 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following improvements have been introduced for organizations using Teams: - This cmdlet now accurately returns users who are voice-enabled (the older cmdlet in version 2.6.0 and earlier returned users without MCOEV* plans assigned). - The result size is not limited to 100 users anymore (the older cmdlet in version 2.6.0 and earlier limited the result size to 100). -In Teams PowerShell Module version 2.6.2 and later, the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following attributes are deprecated for organizations with Teams users using the ExpandLocation parameter: - Force - NumberOfResultsToSkip @@ -36,7 +68,7 @@ In Teams PowerShell Module version 2.6.2 and later, the following attributes are - ResultSize - LicenceState -In Teams PowerShell Module version 2.6.2 and later, the following input parameters are deprecated for organizations with Teams users due to low or zero usage: +In Teams PowerShell Module version 2.6.2 and later in commercial cloud (and Teams PowerShell Module versions 5.0.1 and later in GCCH and DOD), the following input parameters are deprecated for organizations with Teams users due to low or zero usage: - DomainController - Force @@ -56,7 +88,6 @@ PS C:\> Get-CsOnlineVoiceUser -Identity Ken.Myer@contoso.com This example uses the User Principal Name (UPN) to retrieve the location and phone number information. - ## PARAMETERS ### -CivicAddressId @@ -65,8 +96,8 @@ Specifies the identity of the civic address that is assigned to the target users ```yaml Type: XdsCivicAddressId Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -82,7 +113,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -100,8 +131,8 @@ Possible values are: ```yaml Type: MultiValuedProperty Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -116,8 +147,8 @@ Displays the location parameter with its value. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -133,8 +164,8 @@ The default is 100. ```yaml Type: Unlimited Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -153,8 +184,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -166,13 +197,13 @@ Accept wildcard characters: False ### -GetFromAAD *This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage*. -Use this switch to get the users from Azure Active Directory. +Use this switch to get the users from Microsoft Entra ID. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -189,8 +220,8 @@ Use this switch to get only the users in pending state. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -212,8 +243,8 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -229,8 +260,8 @@ You can find location identifiers by using the `Get-CsOnlineLisLocation` cmdlet. ```yaml Type: LocationID Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -245,8 +276,8 @@ If specified, the query will return users who have a phone number assigned. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -261,8 +292,8 @@ If specified, the query will return users who do not have a phone number assigne ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -281,8 +312,8 @@ Possible values are: ```yaml Type: MultiValuedProperty Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -301,8 +332,8 @@ If this parameter is empty, all users are returned. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -319,8 +350,8 @@ The default is 0. ```yaml Type: Unlimited Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -337,8 +368,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -349,23 +380,17 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacUser - ## NOTES - ## RELATED LINKS -[Set-CsOnlineVoiceUser](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceuser?view=skype-ps) - -[Set-CsOnlineVoiceUserBulk](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceuserbulk?view=skype-ps) +[Set-CsOnlineVoiceUser](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md similarity index 76% rename from skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md index e144aab23b..844b74b828 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy +applicable: Microsoft Teams title: Get-CsOnlineVoicemailPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -53,7 +53,6 @@ Get-CsOnlineVoicemailPolicy -Filter "tag:*" Example 3 uses the Filter parameter to return all the voicemail policies that have been configured at the per-user scope. The filter value "tag:*" tells the Get-CsOnlineVoicemailPolicy cmdlet to return only those policies that have an Identity that begins with the string value "tag:". - ## PARAMETERS ### -Identity @@ -62,8 +61,8 @@ A unique identifier specifying the scope, and in some cases the name, of the pol ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -77,8 +76,8 @@ This parameter accepts a wildcard string and returns all voicemail policies with ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -88,8 +87,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -99,15 +97,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Rtc.Management.WritableConfig.Policy.OnlineVoicemail.OnlineVoicemailPolicy - ## NOTES - ## RELATED LINKS -[Set-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoicemailpolicy?view=skype-ps) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/skype/skype-ps/skype/Get-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md similarity index 80% rename from skype/skype-ps/skype/Get-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md index 7d1ffc42c1..b4437f7b08 100644 --- a/skype/skype-ps/skype/Get-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/teams/Get-CsOnlineVoicemailUserSettings.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csonlinevoicemailusersettings -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings +applicable: Microsoft Teams title: Get-CsOnlineVoicemailUserSettings schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -33,7 +33,6 @@ Get-CsOnlineVoicemailUserSettings -Identity sip:user@contoso.com This example gets the online voicemail user settings of user with SIP URI sip:user@contoso.com. - ## PARAMETERS ### -Identity @@ -42,8 +41,8 @@ The Identity parameter represents the ID of the specific user in your organizati ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -68,8 +67,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -79,11 +77,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings - ## NOTES - ## RELATED LINKS -[Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) - +[Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md index 07157aa6e0..9b68146e1f 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csphonenumberassignment +online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Get-CsPhoneNumberAssignment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Get-CsPhoneNumberAssignment @@ -19,17 +20,40 @@ This cmdlet displays information about one or more phone numbers. ### Assignment (Default) ```powershell -Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-CapabilitiesContain ] - [-CivicAddressId ] [-IsoCountryCode ] [-LocationId ] [-NumberType ] - [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] [-TelephoneNumberContain ] - [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] [-TelephoneNumberStartsWith ] [-Top ] - [] +Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-AssignmentCategory ] + [-CapabilitiesContain ] [-CivicAddressId ] [-Filter ] [-IsoCountryCode ] + [-LocationId ] [-NetworkSiteId ] [-NumberType ] [-PstnAssignmentStatus ] [-Skip ] [-TelephoneNumber ] + [-TelephoneNumberContain ] [-TelephoneNumberGreaterThan ] [-TelephoneNumberLessThan ] + [-TelephoneNumberStartsWith ] [-Top ] [] ``` ## DESCRIPTION -This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. - -Returned results are sorted by TelephoneNumber in ascending order. +This cmdlet displays information about one or more phone numbers. You can filter the phone numbers to return by using different parameters. Returned results are sorted by TelephoneNumber in ascending order. Supported list of attributes for Filter are: +- TelephoneNumber +- OperatorId +- PstnAssignmentStatus (also supported AssignmentStatus) +- ActivationState +- IsoCountryCode +- Capability (also supported AcquiredCapabilities) +- IsOperatorConnect +- PstnPartnerName (also supported PartnerName) +- LocationId +- CivicAddressId +- NetworkSiteId +- NumberType +- AssignedPstnTargetId (also supported TargetId) +- TargetType +- AssignmentCategory +- ResourceAccountSharedCallingPolicySupported +- SupportedCustomerActions +- ReverseNumberLookup +- RoutingOptions +- SmsActivationState +- Tags + +If you are using both -Skip X and -Top Y for filtering, the returned results will first be skipped by X, and then the top Y results will be returned. + +By default, this cmdlet returns a maximum of 500 results. A maximum of 1000 results can be returned using -Top filter. If you need to get more than 1000 results, a combination of -Skip and -Top filtering can be used to list incremental returns of 1000 numbers. If a full list of telephone numbers acquired by the tenant is required, you can use [Export-CsAcquiredPhoneNumber](./export-csacquiredphonenumber.md) cmdlet to download a list of all acquired telephone numbers. ## EXAMPLES @@ -39,9 +63,11 @@ Get-CsPhoneNumberAssignment -TelephoneNumber +14025551234 ``` ```output TelephoneNumber : +14025551234 +OperatorId : 2b24d246-a9ee-428b-96bc-fb9d9a053c8d NumberType : CallingPlan ActivationState : Activated AssignedPstnTargetId : dc13d97b-7897-494e-bc28-6b469bf7a70e +AssignmentCategory : Primary Capability : {UserAssignment} City : Omaha CivicAddressId : 703b30e5-dbdd-4132-9809-4c6160a6acc7 @@ -49,10 +75,13 @@ IsoCountryCode : US IsoSubdivision : Nebraska LocationId : 407c17ae-8c41-431e-894a-38787c682f68 LocationUpdateSupported : True -PortInOrderStatus : +NetworkSiteId : +PortInOrderStatus : PstnAssignmentStatus : UserAssigned PstnPartnerId : 7fc2f2eb-89aa-41d7-93de-73d015d22ff0 PstnPartnerName : Microsoft +NumberSource : Online +ReverseNumberLookup : {} ``` This example displays information about the Microsoft Calling Plan subscriber phone number +1 (402) 555-1234. You can see that it is assigned to a user. @@ -62,20 +91,25 @@ Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" ``` ```output TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 NumberType : DirectRouting ActivationState : Activated AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} -City : +City : CivicAddressId : 00000000-0000-0000-0000-000000000000 -IsoCountryCode : -IsoSubdivision : +IsoCountryCode : +IsoSubdivision : LocationId : 00000000-0000-0000-0000-000000000000 LocationUpdateSupported : True -PortInOrderStatus : +NetworkSiteId : +PortInOrderStatus : PstnAssignmentStatus : UserAssigned -PstnPartnerId : -PstnPartnerName : +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} ``` This example displays information about the Direct Routing phone number +1 (206) 555-1000;ext=524. You can see that it is assigned to a user. @@ -83,8 +117,7 @@ This example displays information about the Direct Routing phone number +1 (206) ```powershell Get-CsPhoneNumberAssignment -CapabilitiesContain "VoiceApplicationAssignment,ConferenceAssignment" ``` -This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have -only one of these capabilities assigned won't be returned. +This example returns all phone numbers that have both the capability VoiceApplicationAssignment and the capability ConferenceAssignment assigned, but phone numbers that have only one of these capabilities assigned won't be returned. ### Example 4 ```powershell @@ -110,6 +143,102 @@ Get-CsPhoneNumberAssignment -TelephoneNumberContain "524" ``` This example returns information about all phone numbers that contain the digits 524, including the phone number with extension 524 used in example 2. +### Example 8 +```powershell +Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 +``` +This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. + +### Example 9 +```powershell +Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' +``` +This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. + +### Example 10 +```powershell +Get-CsPhoneNumberAssignment -TelephoneNumber "+12065551000;ext=524" +``` +```output +TelephoneNumber : +12065551000;ext=524 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {SkipInternalVoip} +``` +This example displays when SkipInternalVoip option is turned on for a number. + +### Example 11 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +``` +This example shows a way to use -Filter parameter to display information of a specific number. + +### Example 12 +```powershell +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -like '+12065551000' -and NumberType -eq 'DirectRouting'" +``` +```output +TelephoneNumber : +12065551000 +OperatorId : 83d289bc-a4d3-41e6-8a3f-cff260a3f091 +NumberType : DirectRouting +ActivationState : Activated +AssignedPstnTargetId : 2713551e-ed63-415d-9175-fc4ff825a0be +AssignmentCategory : Primary +Capability : {ConferenceAssignment, VoiceApplicationAssignment, UserAssignment} +City : +CivicAddressId : 00000000-0000-0000-0000-000000000000 +IsoCountryCode : +IsoSubdivision : +LocationId : 00000000-0000-0000-0000-000000000000 +LocationUpdateSupported : True +NetworkSiteId : +PortInOrderStatus : +PstnAssignmentStatus : UserAssigned +PstnPartnerId : +PstnPartnerName : +NumberSource : OnPremises +ReverseNumberLookup : {} +``` +This example shows a way to get filtered results using multiple Filter parameters. + ## PARAMETERS @@ -119,7 +248,7 @@ Filters the returned results based on the number type. Supported values are Acti ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -129,13 +258,12 @@ Accept wildcard characters: False ``` ### -AssignedPstnTargetId -Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, and ObjectId. - +Filters the returned results based on the user or resource account ID the phone number is assigned to. Supported values are UserPrincipalName, SIP address, ObjectId, and the Teams shared calling routing policy instance name. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -144,20 +272,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CapabilitiesContain -Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities +### -AssignmentCategory +This parameter is used to differentiate between Primary and Private line assignment for a user. -are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and OCMobile. +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -CapabilitiesContain +Filters the returned results based on the capabilities assigned to the phone number. You can specify one or more capabilities delimited by a comma. Supported capabilities are ConferenceAssignment, VoiceApplicationAssignment, UserAssignment, and TeamsPhoneMobile. -If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like +If you specify only one capability, you will get all phone numbers returned that have that capability assigned. If you specify a comma separated list for instance like ConferenceAssignment, VoiceApplicationAssignment you will get all phone numbers that have both capabilities assigned, but you won't get phone numbers that have only VoiceApplicationAssignment or ConferenceAssignment assigned as capability. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -167,12 +307,12 @@ Accept wildcard characters: False ``` ### -CivicAddressId -Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using [Get-CsOnlineLisCivicAddress](/powershell/module/skype/get-csonlineliscivicaddress). +Filters the returned results based on the CivicAddressId assigned to the phone number. You can get the CivicAddressId by using [Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress). ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -181,13 +321,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Filter +This can be used to filter on one or more parameters within the search results. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IsoCountryCode -Filters the returned results based on the ISO 3166-1 Alpha-2 contry code assigned to the phone number. +Filters the returned results based on the ISO 3166-1 Alpha-2 country code assigned to the phone number. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -197,12 +352,27 @@ Accept wildcard characters: False ``` ### -LocationId -Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using [Get-CsOnlineLisLocation](/powershell/module/skype/get-csonlinelislocation). +Filters the returned results based on the LocationId assigned to the phone number. You can get the LocationId by using [Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation). ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: +Applicable: Microsoft Teams + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Applicable: Microsoft Teams Required: False @@ -214,11 +384,10 @@ Accept wildcard characters: False ### -NumberType Filters the returned results based on the number type. Supported values are DirectRouting, CallingPlan, and OperatorConnect. - ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -228,13 +397,12 @@ Accept wildcard characters: False ``` ### -PstnAssignmentStatus -Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, and ThirdPartyAppAssigned. - +Filters the returned results based on the assignment status. Support values are Unassigned, UserAssigned, ConferenceAssigned, VoiceApplicationAssigned, ThirdPartyAppAssigned, and PolicyAssigned. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -246,7 +414,6 @@ Accept wildcard characters: False ### -Skip Skips the first X returned results and the default value is 0. - ```yaml Type: System.Int32 Parameter Sets: (All) @@ -259,13 +426,13 @@ Accept wildcard characters: False ``` ### -TelephoneNumber -Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can not have "tel:" prefixed. +Filters the returned results to a specific phone number. It is optional to specify a prefixed "+". The phone number can't have "tel:" prefixed. We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -282,7 +449,7 @@ the digits of the extension. For supported formats see TelephoneNumber. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -298,7 +465,7 @@ range of phone numbers to return results for. For supported formats see Telephon ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -314,7 +481,7 @@ range of phone numbers to return results for. For supported formats see Telephon ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -329,7 +496,7 @@ Filters the returned results based on starts with string match for the specified ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -344,7 +511,7 @@ Returns the first X returned results and the default value is 500. ```yaml Type: System.Int32 Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -366,7 +533,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The activation state of the telephone number. ### AssignedPstnTargetId -The ID of the object the phone number is assigned to. +The ID of the object the phone number is assigned to, either the ObjectId of a user or resource account or the policy instance ID of a Teams shared calling routing policy instance. + +### AssignmentCategory +This parameter is reserved for internal Microsoft use. ### Capability The list of capabilities assigned to the phone number. @@ -381,8 +551,7 @@ The ID of the CivicAddress assigned to the phone number. The ISO country code assigned to the phone number. ### IsoSubDivision -The subdivision within the country assigned to the phone number, for example, the state for US phone numbers. - +The subdivision within the country/region assigned to the phone number, for example, the state for US phone numbers. ### LocationId The ID of the Location assigned to the phone number. @@ -390,9 +559,18 @@ The ID of the Location assigned to the phone number. ### LocationUpdateSupported Boolean stating if updating of the location assigned to the phone number is allowed. +### NetworkSiteId +This parameter is reserved for internal Microsoft use. + +### NumberSource +The source of the phone number. Online for phone numbers assigned in Microsoft 365 and OnPremises for phone numbers assigned in AD on-premises and synchronized into Microsoft 365. + ### NumberType The type of the phone number. +### OperatorId +The ID of the operator. + ### PortInOrderStatus The status of any port in order covering the phone number. @@ -410,12 +588,15 @@ The phone number. The number is always displayed with prefixed "+", even if it w The object returned is of type SkypeTelephoneNumberMgmtCmdletAcquiredTelephoneNumber. +### ReverseNumberLookup +Status of Reverse Number Lookup (RNL). When it is set to SkipInternalVoip, the calls are handled through external PSTN connection instead of internal VoIP lookup. + ## NOTES -The cmdlet is available in Teams PowerShell module 4.0.0 or later. +The cmdlet is available in Teams PowerShell module 4.0.0 or later. The parameter AssignmentCategory was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The output parameter NumberSource was introduced in Teams PowerShell module 5.7.0. The cmdlet is only available in commercial and GCC cloud instances. ## RELATED LINKS -[Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) -[Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Get-CsPhoneNumberTag.md b/teams/teams-ps/teams/Get-CsPhoneNumberTag.md new file mode 100644 index 0000000000..beba5186cd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsPhoneNumberTag.md @@ -0,0 +1,58 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag +applicable: Microsoft Teams +title: Get-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Get-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows the admin to get a list of existing tags for telephone numbers. + +## SYNTAX + +``` +Get-CsPhoneNumberTag [] +``` + +## DESCRIPTION +This cmdlet will get a list of all existing tags that are assigned to phone numbers in the tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsPhoneNumberTag +``` +```output +TagValue +HR +Redmond HQ +Executives +``` + +This example shows how to get a list of existing tags for telephone numbers + +## 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 + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISkypeTelephoneNumberMgmtCmdletTenantTagRecord + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsPolicyPackage.md b/teams/teams-ps/teams/Get-CsPolicyPackage.md index 065a586b22..0e3330e1af 100644 --- a/teams/teams-ps/teams/Get-CsPolicyPackage.md +++ b/teams/teams-ps/teams/Get-CsPolicyPackage.md @@ -5,7 +5,7 @@ title: Get-CsPolicyPackage author: serdarsoysal ms.author: serdars manager: amitar -online version: https://docs.microsoft.com/powershell/module/teams/get-cspolicypackage +online version: https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage schema: 2.0.0 --- @@ -17,14 +17,14 @@ This cmdlet supports retrieving all the policy packages available on a tenant. ## SYNTAX -``` -Get-CsPolicyPackage [[-Identity] ] [] +```powershell +Get-CsPolicyPackage [[-Identity] ] -InputObject [] ``` ## DESCRIPTION This cmdlet supports retrieving all the policy packages available on a tenant. Provide the identity of a specific policy package to retrieve its definition, including details on the policies applied with the package. -For more information on policy packages, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. ## EXAMPLES @@ -80,6 +80,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +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). @@ -91,8 +107,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) -[Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md new file mode 100644 index 0000000000..7152c35e07 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestStatus.md @@ -0,0 +1,66 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +online version: +title: Get-CsSdgBulkSignInRequestStatus +schema: 2.0.0 +--- + +# Get-CsSdgBulkSignInRequestStatus + +## SYNOPSIS +Get the status of an active bulk sign in request. + +## SYNTAX + +``` +Get-CsSdgBulkSignInRequestStatus -Batchid [] +``` + +## DESCRIPTION +Use this cmdlet to get granular device level details of a bulk sign in request. Status is shown for every username and hardware ID pair included in the device details CSV used as input to the bulk sign in request. + +## EXAMPLES + +### Example 1 +```powershell +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC +$newBatchResponse.BatchId +$getBatchStatusResponse = Get-CsSdgBulkSignInRequestStatus -Batchid $newBatchResponse.BatchId +$getBatchStatusResponse | ft +$getBatchStatusResponse.BatchItem +``` + +This example shows how to read the batch status response into a new variable and print the status for every batch item. + +## PARAMETERS + +### -Batchid +Batch ID is the response returned by the `New-CsSdgBulkSignInRequest` cmdlet. It is used as input for querying the status of the batch through `Get-CsSdgBulkSignInRequestStatus` cmdlet. + +```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 + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISdgBulkSignInRequestStatusResult + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md new file mode 100644 index 0000000000..b1f9e93472 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsSdgBulkSignInRequestsSummary.md @@ -0,0 +1,48 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +online version: +title: Get-CsSdgBulkSignInRequestsSummary +schema: 2.0.0 +--- + +# Get-CsSdgBulkSignInRequestsSummary + +## SYNOPSIS +Get the tenant level summary of all bulk sign in requests executed in the past 30 days. + +## SYNTAX + +``` +Get-CsSdgBulkSignInRequestsSummary [] +``` + +## DESCRIPTION +This cmdlet gives the overall tenant level summary of all bulk sign in requests executed for a particular tenant within the last 30 days. Status is shown at batch level as succeeded / failed. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsSdgBulkSignInRequestsSummary +``` + +This example shows how to run the cmdlet to get a tenant level summary. + +## 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 + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ISdgBulkSignInRequestsSummaryResponseItem + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..eed80beb3f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: Get-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Get-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +Get-CsSharedCallQueueHistoryTemplate -Id [] +``` + +## DESCRIPTION +Use the Get-CsSharedCallQueueHistory cmdlet to list the Shared Call Queue History templates + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsSharedCallQueueHistoryTemplate -Id 3a4b3d9b-91d8-4fbf-bcff-6907f325842c +``` + +This example retrieves the Shared Call Queue History Template with the Id `3a4b3d9b-91d8-4fbf-bcff-6907f325842c` + +### -------------------------- Example 2 -------------------------- +``` +Get-CsSharedCallQueueHistoryTemplate +``` + +This example retrieves all the Shared Call Queue History Templates + +## PARAMETERS + +### -Id +The Id of the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: false +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsSharedCallQueueHistoryTemplate](./New-CsSharedCallQueueHistoryTemplate.md) + +[Set-CsSharedCallQueueHistoryTemplate](./Set-CsSharedCallQueueHistoryTemplate.md) + +[Remove-CsSharedCallQueueHistoryTemplate](./Remove-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/Get-CsTeamTemplate.md b/teams/teams-ps/teams/Get-CsTeamTemplate.md index 78c2997490..de8f75a2f2 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplate.md +++ b/teams/teams-ps/teams/Get-CsTeamTemplate.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate title: Get-CsTeamTemplate author: serdarsoysal ms.author: serdars -ms.reviewer: +ms.reviewer: manager: farahf schema: 2.0.0 --- @@ -45,15 +45,15 @@ This cmdlet supports retrieving details of a team template available to your ten ### EXAMPLE 1 ```powershell -PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Get-CsTeamTemplate -OdataId $_.OdataId} ``` -Within the universe of templates the admin’s tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include ‘test’. +Within the universe of templates the admin's tenant has access to, returns a template definition object (displayed as a JSON by default) for every custom and every Microsoft en-US template which names include 'test'. ### EXAMPLE 2 ```powershell -PS C:> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' +PS C:\> Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/cefcf333-91a9-43d0-919f-bbca5b7d2b24/Tenant/en-US' > 'config.json' ``` Saves the template with specified template ID as a JSON file. @@ -210,35 +210,35 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT \: Identity Parameter - - `[Bssid ]`: - - `[ChassisId ]`: + - `[Bssid ]`: + - `[ChassisId ]`: - `[CivicAddressId ]`: Civic address id. - - `[Country ]`: + - `[Country ]`: - `[GroupId ]`: The ID of a group whose policy assignments will be returned. - - `[Id ]`: - - `[Identity ]`: - - `[Locale ]`: + - `[Id ]`: + - `[Identity ]`: + - `[Locale ]`: - `[LocationId ]`: Location id. - `[OdataId ]`: A composite URI of a template. - `[OperationId ]`: The ID of a batch policy assignment operation. - - `[OrderId ]`: + - `[OrderId ]`: - `[PackageName ]`: The name of a specific policy package - `[PolicyType ]`: The policy type for which group policy assignments will be returned. - - `[Port ]`: - - `[PortInOrderId ]`: + - `[Port ]`: + - `[PortInOrderId ]`: - `[PublicTemplateLocale ]`: Language and country code for localization of publicly available templates. - - `[SubnetId ]`: - - `[TenantId ]`: + - `[SubnetId ]`: + - `[TenantId ]`: - `[UserId ]`: UserId. Supports Guid. Eventually UPN and SIP. ## RELATED LINKS -[Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -[Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate) +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) -[New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate) +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) -[Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate) +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) -[Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate) +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamTemplateList.md b/teams/teams-ps/teams/Get-CsTeamTemplateList.md index 5b173a7b06..c9928c4038 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplateList.md +++ b/teams/teams-ps/teams/Get-CsTeamTemplateList.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist title: Get-CsTeamTemplateList author: serdarsoysal ms.author: serdars -ms.reviewer: +ms.reviewer: manager: farahf schema: 2.0.0 --- @@ -14,7 +14,7 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes includes OData Id, template name, short description, count of channels and count of applications. +This cmdlet supports retrieving information of all team templates available to your tenant, including both first party Microsoft team templates as well as custom templates. The templates information retrieved includes OData Id, template name, short description, count of channels and count of applications. Note: All custom templates will be retrieved, regardless of the locale specification. If you have hidden templates in the admin center, you will still be able to see the hidden templates here. ## SYNTAX @@ -40,20 +40,20 @@ Get a list of available team templates ### EXAMPLE 1 ```powershell -PS C:> Get-CsTeamTemplateList +PS C:\> Get-CsTeamTemplateList ``` -Returns all en-US templates within the universe of templates the admin’s tenant has access to. +Returns all en-US templates within the universe of templates the admin's tenant has access to. Note: All 1P Microsoft templates will always be returned in the specified locale. If the locale is not specified, en-US will be used. ### EXAMPLE 2 ```powershell -PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where ChannelCount -GT 3 ``` -Returns all en-US templates that have 3 channels within the universe of templates the admin’s tenant has access to. +Returns all en-US templates that have 3 channels within the universe of templates the admin's tenant has access to. ## PARAMETERS @@ -136,12 +136,12 @@ Eventually UPN and SIP. ## RELATED LINKS -[Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -[Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate) +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) -[New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate) +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) -[Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate) +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) -[Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate) +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..77a631f12f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsAIPolicy.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Get-CsTeamsAIPolicy + +## SYNOPSIS + +This cmdlet retrieves all Teams AI policies for the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsAIPolicy [[-Identity] ] [-Filter ] [] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet retrieves all Teams AI policies for the tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsAIPolicy +``` + +Retrieves Teams AI policies and shows "EnrollFace", "EnrollVoice" and "SpeakerAttributionBYOD" values. + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md index 54896dace8..6ba81b228a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md @@ -4,7 +4,7 @@ Module Name: MicrosoftTeams title: Get-CsTeamsAcsFederationConfiguration author: tomkau ms.author: tomkau -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration schema: 2.0.0 --- @@ -12,56 +12,88 @@ schema: 2.0.0 ## SYNOPSIS -**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. This preview version is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). - -This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. For more information, refer to [Azure Communication Services and Teams Interoperability](/azure/communication-services/concepts/teams-interop). +This cmdlet is used to retrieve the federation configuration between Teams and Azure Communication Services. For more information, refer to [Azure Communication Services and Teams Interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). ## SYNTAX ```powershell Get-CsTeamsAcsFederationConfiguration + [-Identity ] + [-Filter ] + [] ``` ## DESCRIPTION -Federation between Teams and Azure Communication Services (ACS) allows users of custom solutions built with ACS to connect and communicate with Teams users over voice, video, chat, and more. For more information, see [Teams interoperability](/azure/communication-services/concepts/teams-interop). +Federation between Teams and Azure Communication Services (ACS) allows users of custom solutions built with ACS to connect and communicate with Teams users over voice, video, Teams users over voice, video and screen sharing, and more. For more information, see [Teams interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This cmdlet is used retrieve the Teams and ACS federation configuration for a Teams tenant. -You must be a Teams service admin, a Teams communication admin, or Global Administrator for your organization to run the cmdlet. +You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. ## Examples ### Example 1 -In this example, federation has been enabled for just one ACS resource. - ```powershell -Get-CsTeamsAcsFederationConfiguration -``` -```Output +PS C:\> Get-CsTeamsAcsFederationConfiguration + Identity : Global AllowedAcsResources : {'faced04c-2ced-433d-90db-063e424b87b1'} -BlockedAcsResources : {} EnableAcsUsers : True -AllowAllAcsResources : False ``` -### Example 2 -In this example, federation is enabled for all ACS resources except for two. +In this example, federation has been enabled for just one ACS resource. +### Example 2 ```powershell -Get-CsTeamsAcsFederationConfiguration -``` -```Output +PS C:\> Get-CsTeamsAcsFederationConfiguration + Identity : Global AllowedAcsResources : {} -BlockedAcsResources : {'bf19b7db-6960-41e5-a139-2aa373474354','dac4607d-d2d0-40e5-84df-6f32ebd1251b'} -EnableAcsUsers : True -AllowAllAcsResources : True +EnableAcsUsers : False ``` +In this example, federation is disabled for all ACS resources. + ## PARAMETERS +### -Filter +Enables you to use wildcards when specifying the Teams and ACS federation configuration settings to be returned. +Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. +However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the collection of tenant federation configuration settings to be modified. Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the Set-CsTenantFederationConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. For example: + +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` + +```yaml +Type: String +Parameter Sets: Identity +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](http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS @@ -70,10 +102,10 @@ AllowAllAcsResources : True ## RELATED LINKS -[Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) +[Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) -[New-CsExternalAccessPolicy](/powershell/module/skype/new-csexternalaccesspolicy?view=skype-ps) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](/powershell/module/skype/set-csexternalaccesspolicy?view=skype-ps) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](/powershell/module/skype/grant-csexternalaccesspolicy?view=skype-ps) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md similarity index 50% rename from skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md index 8262b19623..cc36983ff2 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md @@ -1,120 +1,162 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsapppermissionpolicy -applicable: Skype for Business Online -title: Get-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# Get-CsTeamsAppPermissionPolicy - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsAppPermissionPolicy [-Tenant ] [[-Identity] ] [-LocalStore] - [] -``` - -### Filter -``` -Get-CsTeamsAppPermissionPolicy [-Tenant ] [-Filter ] [-LocalStore] [] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally omitted. - -## PARAMETERS - -### -Filter -Do not use - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Do not use. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Do not use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -{{Fill Tenant Description}} - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Get-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# Get-CsTeamsAppPermissionPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . + +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsAppPermissionPolicy [-Tenant ] [[-Identity] ] [-LocalStore] + [] +``` + +### Filter +``` +Get-CsTeamsAppPermissionPolicy [-Tenant ] [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . + +## EXAMPLES + +### Example 1 + +```powershell +Get-CsTeamsAppPermissionPolicy -Identity Global +``` + +```Output +Identity : Global +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList +``` +Get the global Teams app permission policy. + +### Example 2 + +```powershell +Get-CsTeamsAppPermissionPolicy +``` + +```Output +Identity : Global +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList + +Identity : Tag:test +DefaultCatalogApps : {Id=26bc2873-6023-480c-a11b-76b66605ce8c, Id=0d820ecd-def2-4297-adad-78056cde7c78, Id=com.microsoft.teamspace.tab.planner} +GlobalCatalogApps : {} +PrivateCatalogApps : {} +Description : +DefaultCatalogAppsType : AllowedAppList +GlobalCatalogAppsType : AllowedAppList +PrivateCatalogAppsType : AllowedAppList +``` +Get all the Teams app permission policies. + +## PARAMETERS + +### -Filter +Do not use + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the app setup permission policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md similarity index 63% rename from skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md index 527ff3c440..47de4b4b99 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsappsetuppolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsappsetuppolicy +applicable: Microsoft Teams title: Get-CsTeamsAppSetupPolicy schema: 2.0.0 ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Get-CsTeamsAppSetupPolicy @@ -17,7 +18,7 @@ author: tomkau As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## SYNTAX @@ -37,12 +38,54 @@ Get-CsTeamsAppSetupPolicy [-Tenant ] [-Filter ] [-LocalStor As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## EXAMPLES ### Example 1 -Intentionally not provided + +```powershell +Get-CsTeamsAppSetupPolicy -Identity Global +``` + +```Output +Identity : Global +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4...} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True +``` +Get all the Teams App Setup Policies. + +### Example 2 + +```powershell +Get-CsTeamsAppSetupPolicy +``` + +```Output +Identity : Global +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4...} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True + +Identity : Tag:Set-test +AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} +PinnedAppBarApps : {Id=14d6962d-6eeb-4f48-8890-de55454bb136;Order=1, Id=86fcd49b-61a2-4701-b771-54728cd291fb;Order=2, Id=2a84919f-59d8-4441-a975-2a8c2643b741;Order=3, Id=ef56c0de-36fc-4ef8-b417-3d82ba9d073c;Order=4...} +PinnedMessageBarApps : {} +AppPresetMeetingList : {} +Description : +AllowSideLoading : True +AllowUserPinning : True +``` +Get all the Teams App Setup Policies. ## PARAMETERS @@ -62,7 +105,7 @@ Accept wildcard characters: False ``` ### -Identity -Do not use. +Name of App setup policy. If empty, all Identities will be used by default. ```yaml Type: XdsIdentity @@ -107,14 +150,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Get-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md similarity index 80% rename from skype/skype-ps/skype/Get-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md index 8f6e941544..77cad0be0c 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/get-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy +title: Get-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -40,7 +41,7 @@ The command shown in Example 1, Get-CsTeamsAudioConferencingPolicy is called wit PS C:\> Get-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" ``` -The command shown in Example 2, Get-CsTeamsAudioConferencingPolicy is used to return the per-user audio conferencing policy that has an Identity “EMEA Users”. Because identities are unique, this command will never return more than one item. +The command shown in Example 2, Get-CsTeamsAudioConferencingPolicy is used to return the per-user audio conferencing policy that has an Identity "EMEA Users". Because identities are unique, this command will never return more than one item. ## PARAMETERS @@ -60,7 +61,7 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier for the policy to be retrieved. To retrieve the global policy, use this syntax: -Identity global. To retrieve a per-user policy use syntax similar to this: -Identity “EMEA Users”. +Unique identifier for the policy to be retrieved. To retrieve the global policy, use this syntax: -Identity global. To retrieve a per-user policy use syntax similar to this: -Identity "EMEA Users". If this parameter is not included, the Get-CsTeamsAudioConferencingPolicy cmdlet will return a collection of all the teams audio conferencing policies configured for use in your organization. ```yaml @@ -102,8 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md similarity index 68% rename from skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md index 9d9e8099f4..479035c0ea 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md @@ -1,159 +1,127 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscallholdpolicy -applicable: Microsoft Teams -title: Get-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: -manager: abnair -ms.author: jomarque -author: joelhmarquez ---- - -# Get-CsTeamsCallHoldPolicy - -## SYNOPSIS - -Returns information about the policies configured to customize the call hold experience for Teams clients. - - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsCallHoldPolicy [-Tenant ] [[-Identity] ] [-LocalStore] - [] -``` - -### Filter -``` -Get-CsTeamsCallHoldPolicy [-Tenant ] [-Filter ] [-LocalStore] [] -``` - -## DESCRIPTION -Teams call hold policies are used to customize the call hold experience for teams clients. -When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. - -Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsCallHoldPolicy -``` - -The command shown in Example 1 returns information for all the Teams call hold policies configured for use in the tenant. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerCallHoldPolicy' -``` - -In Example 2, information is returned for a single Teams call hold policy: the policy with the Identity ContosoPartnerCallHoldPolicy. - -### Example 3 -```powershell -PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' -``` - -The command shown in Example 3 returns information about all the Teams call hold policies configured at the per-user scope. -To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". - -## PARAMETERS - -### -Filter -Enables you to use wildcards when retrieving one or more Teams call hold policies. -For example, to return all the policies configured at the per-user scope, use this syntax: - --Filter "Tag:\*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier of the Teams call hold policy to be retrieved. - -To return the global policy, use this syntax: - -`-Identity "Global"` - -To return a policy configured at the per-user scope, use syntax like this: - -`-Identity "ContosoPartnerCallHoldPolicy"` - -You cannot use wildcard characters when specifying the Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) - -[Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) - -[Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) - -[Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy +applicable: Microsoft Teams +title: Get-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Get-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Returns information about the policies configured to customize the call hold experience for Teams clients. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCallHoldPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsCallHoldPolicy [-Filter ] [] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy +``` + +The command shown in Example 1 returns information for all the Teams call hold policies configured for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerCallHoldPolicy' +``` + +In Example 2, information is returned for a single Teams call hold policy: the policy with the Identity ContosoPartnerCallHoldPolicy. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' +``` + +The command shown in Example 3 returns information about all the Teams call hold policies configured at the per-user scope. +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more Teams call hold policies. +For example, to return all the policies configured at the per-user scope, use this syntax: + +-Filter "Tag:\*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the Teams call hold policy to be retrieved. + +To return the global policy, use this syntax: + +`-Identity "Global"` + +To return a policy configured at the per-user scope, use syntax like this: + +`-Identity "ContosoPartnerCallHoldPolicy"` + +You cannot use wildcard characters when specifying the Identity. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsTeamsCallParkPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md index c73ad3880a..e9b195959d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsCallParkPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscallparkpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy +applicable: Microsoft Teams title: Get-CsTeamsCallParkPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsCallParkPolicy @@ -106,14 +106,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Get-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md similarity index 74% rename from skype/skype-ps/skype/Get-CsTeamsCallingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md index 21f1abab52..44a936109d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsCallingPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscallingpolicy +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy applicable: Microsoft Teams title: Get-CsTeamsCallingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -85,23 +85,24 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None + ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) -[Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md index 67801bf3f7..444867452e 100644 --- a/skype/skype-ps/skype/Get-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsChannelsPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamschannelspolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy +applicable: Microsoft Teams title: Get-CsTeamsChannelsPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsChannelsPolicy @@ -107,8 +107,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Get-CsTeamsClientConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsTeamsClientConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md index 0c36fa8cfe..8ade0c1ba8 100644 --- a/skype/skype-ps/skype/Get-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsClientConfiguration.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsclientconfiguration -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsclientconfiguration +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Get-CsTeamsClientConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsClientConfiguration @@ -106,14 +106,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Get-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md similarity index 81% rename from skype/skype-ps/skype/Get-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md index e49526406c..a480bcadfc 100644 --- a/skype/skype-ps/skype/Get-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md @@ -1,192 +1,194 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication -applicable: Skype for Business Online -title: Get-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Get-CsTeamsComplianceRecordingApplication - -## SYNOPSIS -Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] - [-LocalStore] [] -``` - -### Filter -``` -Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Filter ] - [-LocalStore] [] -``` - -## DESCRIPTION -Policy-based recording applications are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. - -Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. - -Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -Once the association is done, the Identity of these application instances becomes \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -Note that if neither the Identity nor the Filter parameters are specified, then Get-CsTeamsComplianceRecordingApplication returns all application instances of policy-based recording applications that are associated with a Teams recording policy. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. -Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingApplication -``` - -The command shown in Example 1 returns information for all the application instances of policy-based recording applications associated with Teams recording policies. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144' -``` - -In Example 2, information is returned for a single application instance of a policy-based recording application with the Identity Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144. - -### Example 3 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingApplication -Filter 'Tag:*' -``` - -The command shown in Example 3 returns all the application instances associated with Teams recording policies at the per-user scope. -To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". - -### Example 4 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingApplication -Filter 'Tag:ContosoPartnerComplianceRecordingPolicy*' -``` - -The command shown in Example 4 returns all the application instances associated with Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. -To do this, the command uses the Filter parameter and the filter value "Tag:ContosoPartnerComplianceRecordingPolicy\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:ContosoPartnerComplianceRecordingPolicy". - -## PARAMETERS - -### -Filter -Enables you to use wildcards when retrieving one or more application instances of policy-based recording applications. -For example, to return all the application instances associated with Teams recording policies at the per-user scope, use this syntax: - --Filter "Tag:\*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Identity -Unique identifier of the application instance of a policy-based recording application to be retrieved. - -You cannot use wildcard characters when specifying the Identity. - -Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -Once the association is done, the Identity of these application instances becomes \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: Get-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Get-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Returns information about the application instances of policy-based recording applications that have been configured for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] + [-LocalStore] [] +``` + +### Filter +``` +Get-CsTeamsComplianceRecordingApplication [-Tenant ] [-Filter ] + [-LocalStore] [] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Note that if neither the Identity nor the Filter parameters are specified, then Get-CsTeamsComplianceRecordingApplication returns all application instances of policy-based recording applications that are associated with a Teams recording policy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication +``` + +The command shown in Example 1 returns information for all the application instances of policy-based recording applications associated with Teams recording policies. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144' +``` + +In Example 2, information is returned for a single application instance of a policy-based recording application with the Identity Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication -Filter 'Tag:*' +``` + +The command shown in Example 3 returns all the application instances associated with Teams recording policies at the per-user scope. +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". + +### Example 4 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication -Filter 'Tag:ContosoPartnerComplianceRecordingPolicy*' +``` + +The command shown in Example 4 returns all the application instances associated with Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. +To do this, the command uses the Filter parameter and the filter value "Tag:ContosoPartnerComplianceRecordingPolicy\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:ContosoPartnerComplianceRecordingPolicy". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more application instances of policy-based recording applications. +For example, to return all the application instances associated with Teams recording policies at the per-user scope, use this syntax: + +-Filter "Tag:\*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Identity +Unique identifier of the application instance of a policy-based recording application to be retrieved. + +You cannot use wildcard characters when specifying the Identity. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Get-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md similarity index 77% rename from skype/skype-ps/skype/Get-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md index 519132a8eb..a406247e81 100644 --- a/skype/skype-ps/skype/Get-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md @@ -1,187 +1,189 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy -applicable: Skype for Business Online -title: Get-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Get-CsTeamsComplianceRecordingPolicy - -## SYNOPSIS -Returns information about the policies configured for governing automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] - [-LocalStore] [] -``` - -### Filter -``` -Get-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Filter ] - [-LocalStore] [] -``` - -## DESCRIPTION -Teams recording policies are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. - -Note that if neither the Identity nor the Filter parameters are specified, then Get-CsTeamsComplianceRecordingPolicy returns all the Teams recording policies configured for use in the tenant. - -Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. -Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. -The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. -Existing calls and meetings are unaffected. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingPolicy -``` - -The command shown in Example 1 returns information for all the Teams recording policies configured for use in the tenant. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -``` - -In Example 2, information is returned for a single Teams recording policy: the policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -### Example 3 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingPolicy -Filter 'Tag:*' -``` - -The command shown in Example 3 returns information about all the Teams recording policies configured at the per-user scope. -To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". - -## PARAMETERS - -### -Filter -Enables you to use wildcards when retrieving one or more Teams recording policies. -For example, to return all the policies configured at the per-user scope, use this syntax: - --Filter "Tag:\*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Identity -Unique identifier of the Teams recording policy to be retrieved. -To return the global policy, use this syntax: - --Identity "Global" - -To return a policy configured at the per-user scope, use syntax like this: - --Identity "ContosoPartnerComplianceRecordingPolicy" - -You cannot use wildcard characters when specifying the Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Get-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Get-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Returns information about the policies configured for governing automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] + [-LocalStore] [] +``` + +### Filter +``` +Get-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Filter ] + [-LocalStore] [] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that if neither the Identity nor the Filter parameters are specified, then Get-CsTeamsComplianceRecordingPolicy returns all the Teams recording policies configured for use in the tenant. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy +``` + +The command shown in Example 1 returns information for all the Teams recording policies configured for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' +``` + +In Example 2, information is returned for a single Teams recording policy: the policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy -Filter 'Tag:*' +``` + +The command shown in Example 3 returns information about all the Teams recording policies configured at the per-user scope. +To do this, the command uses the Filter parameter and the filter value "Tag:\*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "Tag:". + +## PARAMETERS + +### -Filter +Enables you to use wildcards when retrieving one or more Teams recording policies. +For example, to return all the policies configured at the per-user scope, use this syntax: + +-Filter "Tag:\*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -Identity +Unique identifier of the Teams recording policy to be retrieved. +To return the global policy, use this syntax: + +-Identity "Global" + +To return a policy configured at the per-user scope, use syntax like this: + +-Identity "ContosoPartnerComplianceRecordingPolicy" + +You cannot use wildcard characters when specifying the Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md similarity index 92% rename from skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md index e33416cd06..e56310edf7 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsCortanaPolicy.md @@ -1,128 +1,129 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscortanapolicy -applicable: Skype for Business Online -title: Get-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta -author: akshbhat -ms.author: akshbhat -ms.reviewer: ---- - -# Get-CsTeamsCortanaPolicy - -## SYNOPSIS -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsCortanaPolicy [-Tenant ] [[-Identity] ] [-LocalStore] [] -``` - -### Filter -``` -Get-CsTeamsCortanaPolicy [-Tenant ] [-Filter ] [-LocalStore] [] -``` - -## DESCRIPTION - -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, if a user can use Cortana voice assistant in Microsoft Teams and determines Cortana invocation behavior via CortanaVoiceInvocationMode parameter - - -* Disabled - Cortana voice assistant is disabled -* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation -* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsCortanaPolicy -``` -In the first example, the Get-CsTeamsCortanaPolicy cmdlet is called without specifying any additional parameters. This causes the Get-CsTeamsCortanaPolicy cmdlet to return a collection of all the Cortana voice assistant policies configured for use in your organization. - -## PARAMETERS - -### -Filter - -Enables you to use wildcards when specifying the policy (or policies) to be retrieved. For example, this syntax returns all the policies that have been configured at the site scope: -Filter "site:". This syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:". -You cannot use both the Filter and the Identity parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Unique identifier for the policy to be returned. To return the global policy, use this syntax: -Identity global. To return a policy configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To return a policy configured at the service scope, use syntax similar to this: -Identity "Registrar:atl-cs-001.litwareinc.com". - -Policies can also be configured at the per-user scope. To return one of these policies, use syntax similar to this: -Identity "SalesDepartmentPolicy". -If this parameter is not included then all of Cortana voice assistant policies configured for use in your organization will be returned. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore - -Retrieves the Cortana voice assistant policy data from the local replica of the Central Management store rather than from the Central Management store itself. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Cortana voice assistant policies are being returned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Get-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCortanaPolicy [-Tenant ] [[-Identity] ] [-LocalStore] [] +``` + +### Filter +``` +Get-CsTeamsCortanaPolicy [-Tenant ] [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION + +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, if a user can use Cortana voice assistant in Microsoft Teams and determines Cortana invocation behavior via CortanaVoiceInvocationMode parameter - + +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsCortanaPolicy +``` +In the first example, the Get-CsTeamsCortanaPolicy cmdlet is called without specifying any additional parameters. This causes the Get-CsTeamsCortanaPolicy cmdlet to return a collection of all the Cortana voice assistant policies configured for use in your organization. + +## PARAMETERS + +### -Filter + +Enables you to use wildcards when specifying the policy (or policies) to be retrieved. For example, this syntax returns all the policies that have been configured at the site scope: -Filter "site:". This syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:". +You cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be returned. To return the global policy, use this syntax: -Identity global. To return a policy configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To return a policy configured at the service scope, use syntax similar to this: -Identity "Registrar:atl-cs-001.litwareinc.com". + +Policies can also be configured at the per-user scope. To return one of these policies, use syntax similar to this: -Identity "SalesDepartmentPolicy". +If this parameter is not included then all of Cortana voice assistant policies configured for use in your organization will be returned. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore + +Retrieves the Cortana voice assistant policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Cortana voice assistant policies are being returned. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..963877780a --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md @@ -0,0 +1,79 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscustombannertext +title: Get-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# Get-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsCustomBannerText [[-Identity] ] [] +``` + +## DESCRIPTION + +Returns all or a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsCustomBannerText +``` + +This example gets the properties of all instances of the TeamsCustomBannerText. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsCustomBannerText -Identity CustomText +``` + +This example gets the properties of the CustomText instance of TeamsCustomBannerText. + +## PARAMETERS + +### -Identity +Policy instance name (optional). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +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 + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/skype/skype-ps/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md similarity index 90% rename from skype/skype-ps/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md index f0e4b63e5c..9a3a36317e 100644 --- a/skype/skype-ps/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,16 +1,16 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamseducationassignmentsapppolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationassignmentsapppolicy +applicable: Microsoft Teams title: Get-CsTeamsEducationAssignmentsAppPolicy schema: 2.0.0 ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- - # Get-CsTeamsEducationAssignmentsAppPolicy ## SYNOPSIS @@ -106,14 +106,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md new file mode 100644 index 0000000000..09801a74c1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsEducationConfiguration +author: SaritaBehera +ms.author: saritabehera +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsEducationConfiguration + +## SYNOPSIS + +This cmdlet is used to retrieve the organization-wide education configuration for Teams. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsEducationConfiguration [-Identity ] [] +``` + +### Filter +```powershell +Get-CsTeamsEducationConfiguration [-Filter ] [] +``` + +## DESCRIPTION + +This cmdlet is used to retrieve the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + +You must be a Teams Service Administrator for your organization to run the cmdlet. + +## Examples + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEducationConfiguration + +Identity : Global +ParentGuardianPreferredContactMethod : Email +UpdateParentInformation : Enabled +``` + +In this example, the organization has set the defaults as follows: + +- Email is set as the preferred contact method for the parent communication invites. +- Capability to edit parent contact information by educators is enabled. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters in order to return a collection of team education configuration settings. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the configuration. + +```yaml +Type: String +Parameter Sets: Identity +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 + +[Set-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration) diff --git a/skype/skype-ps/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md similarity index 71% rename from skype/skype-ps/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md index ac76874338..82cff25140 100644 --- a/skype/skype-ps/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsemergencycallroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy applicable: Microsoft Teams title: Get-CsTeamsEmergencyCallRoutingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc schema: 2.0.0 @@ -86,7 +86,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -98,10 +98,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md similarity index 60% rename from skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md index 4b75b3eec7..2bae2ad08c 100644 --- a/skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsemergencycallingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy applicable: Microsoft Teams title: Get-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc schema: 2.0.0 @@ -52,6 +52,24 @@ Get-CsTeamsEmergencyCallingPolicy -Filter Test* Retrieves all emergency calling policies with Identity starting with Test. +### Example 4 +```powershell +(Get-CsTeamsEmergencyCallingPolicy -Identity TestECP).ExtendedNotifications +``` +```output +EmergencyDialString : 112 +NotificationGroup : alert2@contoso.com +NotificationDialOutNumber : +NotificationMode : ConferenceUnMuted + +EmergencyDialString : 911 +NotificationGroup : alert3@contoso.com +NotificationDialOutNumber : +14255551234 +NotificationMode : NotificationOnly +``` + +This example displays extended notifications set on emergency calling policy with the identity TestECP. + ## PARAMETERS ### -Identity @@ -85,7 +103,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -94,14 +112,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md index 6dd1d0754d..d1c2fd903d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy title: Get-CsTeamsEnhancedEncryptionPolicy -author: xinawang -ms.author: xinawang +author: serdarsoysal +ms.author: serdars manager: mdress schema: 2.0.0 --- @@ -24,7 +24,6 @@ Get-CsTeamsEnhancedEncryptionPolicy [-LocalStore] [[-Identity] ] [-Filte Returns information about the Teams enhanced encryption policies configured for use in your organization. The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. - ## EXAMPLES ### EXAMPLE 1 @@ -63,7 +62,6 @@ Unique identifier assigned to the Teams enhanced encryption policy. Use the "Global" Identity if you wish to retrieve the policy set for the entire tenant. - ```yaml Type: XdsIdentity Parameter Sets: (All) @@ -94,21 +92,20 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) - -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) -[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) -[Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..db497af1ae --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md @@ -0,0 +1,90 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseventspolicy +title: Get-CsTeamsEventsPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsEventsPolicy + +## SYNOPSIS +Returns information about the Teams Events policy. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsEventsPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsEventsPolicy [-Filter ] [] +``` + +## DESCRIPTION +Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsEventsPolicy +``` + +Returns information for all Teams Events policies available for use in the tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsEventsPolicy -Identity Global +``` + +Returns information for Teams Events policy with identity "Global". + +## PARAMETERS + +### -Filter +Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md new file mode 100644 index 0000000000..ca976fe3ca --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsExternalAccessConfiguration.md @@ -0,0 +1,83 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsexternalaccessconfiguration +title: Get-CsTeamsExternalAccessConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsExternalAccessConfiguration + +## SYNOPSIS +The TeamsExternalAccessConfiguration contains all configurations that can be used to enhance the security of the entire organization, such as managing blocked users. This cmdlet returns the current settings of your organization. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsExternalAccessConfiguration [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsExternalAccessConfiguration [-Filter ] [] +``` + +## DESCRIPTION +Retrieves the current Teams External Access Configuration in the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsExternalAccessConfiguration +``` + +In this example, we retrieve the Teams External Access Configuration in the organization. + +## PARAMETERS + +### -Filter +Internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only value accepted is Global + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +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 + +### TeamsExternalAccessConfiguration.Cmdlets.TeamsExternalAccessConfiguration + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md similarity index 62% rename from skype/skype-ps/skype/Get-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md index ec03698b0b..5000645a03 100644 --- a/skype/skype-ps/skype/Get-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsFeedbackPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsfeedbackpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfeedbackpolicy +applicable: Microsoft Teams title: Get-CsTeamsFeedbackPolicy schema: 2.0.0 manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau ms.reviewer: --- @@ -18,8 +18,14 @@ Use this cmdlet to retrieve the current Teams Feedback policies (the ability to ## SYNTAX +### Identity (Default) +``` +Get-CsTeamsFeedbackPolicy [[-Identity] ] [] +``` + +### Filter ``` -Get-CsTeamsFeedbackPolicy [-LocalStore] [[-Identity] ] [-Tenant ] [-Filter ] +Get-CsTeamsFeedbackPolicy [-Filter ] [] ``` ## DESCRIPTION @@ -36,27 +42,12 @@ In this example, we retrieve all the existing Teams feedback policies in the org ## PARAMETERS -### -Filter -Internal Microsoft use - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The unique identifier of the policy. ```yaml -Type: Object -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False @@ -66,12 +57,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Internal Microsoft use. +### -Filter +Internal Microsoft use ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: Required: False @@ -81,20 +72,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Internal Microsoft use. - -```yaml -Type: Object -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 @@ -103,6 +82,7 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..0340a280a1 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsFilesPolicy.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy +title: Get-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsFilesPolicy + +## SYNOPSIS +Use the \`Get-CsTeamsFilesPolicy\` cmdlet to get a list of all pre-configured policy instances related to teams files. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsFilesPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsFilesPolicy [-Filter ] [] +``` + +## DESCRIPTION +This cmdlet retrieves information about one or more teams files policies that have been configured for use in your organization. +teams files policies are used by the organization to manage files-related features such as third party storage provider for files from teams. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsFilesPolicy +``` + +In Example 1, the Get-CsTeamsFilesPolicy cmdlet is called without any additional parameters; this returns a collection of all the teams files policies configured for use in your organization. + +### Example 2 +``` +Get-CsTeamsFilesPolicy -Identity TranscriptionDisabled +``` + +In Example 2, the Get-CsTeamsFilesPolicy cmdlet is used to return the per-user teams files policy that has an Identity TranscriptionDisabled. +Because identities are unique, this command will never return more than one item. + +### Example 3 +``` +Get-CsTeamsFilesPolicy -Filter "tag:*" +``` + +Example 3 uses the Filter parameter to return all the teams files policies that have been configured at the per-user scope. +The filter value "tag:*" tells the Get-CsTeamsFilesPolicy cmdlet to return only those policies that have an Identity that begins with the string value "tag:". + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. +If this parameter is omitted, all teams files policies available for use are returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +This parameter accepts a wildcard string and returns all teams files policies with identities matching that string. +For example, a Filter value of Tag:* will return all preconfigured teams files policy instances (excluding forest default "Global") available to use by the tenant admins. + +```yaml +Type: String +Parameter Sets: Filter +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md new file mode 100644 index 0000000000..274a3a8171 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration +title: Get-CsTeamsFirstPartyMeetingTemplateConfiguration +schema: 2.0.0 +author: boboPD +ms.author: pradas +--- + +# Get-CsTeamsFirstPartyMeetingTemplateConfiguration + +## SYNOPSIS +This cmdlet fetches the first-party meeting templates stored on the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsFirstPartyMeetingTemplateConfiguration [[-Identity] ] [] +``` + +## DESCRIPTION +Fetches the list of first-party templates on the tenant. Each template object contains its list of meeting options, the name of the template, and its ID. + +This is a read-only configuration. + +## EXAMPLES + +### Example 1 - Fetching all first party meeting templates on the tenant + +```powershell +PS C:\> Get-CsTeamsFirstPartyMeetingTemplateConfiguration + +Identity : Global +TeamsMeetingTemplates : {default, firstparty_30d773c0-1b4e-4bf6-970b-73f544c054bb, + firstparty_399f69a3-c482-41bf-9cf7-fcdefe269ce6, + firstparty_64c92390-c8a2-471e-96d9-4ee8f6080155...} +Description : The `TeamsMeetingTemplates` property contains the meeting template details: + +TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby, + EntryExitAnnouncementsEnabled...} +Description : Townhall +Name : firstparty_21f91ef7-6265-4064-b78b-41ab66889d90 +Category : + +TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption} +Description : Virtual appointment +Name : firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 +Category : +``` + +Fetches all the first-party templates on the tenant. + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the configuration. + +Note: This configuration is read only and will only have the Global instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) diff --git a/skype/skype-ps/skype/Get-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md index 5f0314b9f8..c14d3fbeec 100644 --- a/skype/skype-ps/skype/Get-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsGuestCallingConfiguration.md @@ -1,12 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestcallingconfiguration +Module Name: MicrosoftTeams title: Get-CsTeamsGuestCallingConfiguration schema: 2.0.0 -manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +manager: bulenteg +ms.reviewer: --- # Get-CsTeamsGuestCallingConfiguration @@ -39,7 +40,7 @@ Returns information about the GuestCallingConfiguration, which specifies what op Get-CsTeamsGuestCallingConfiguration ``` -Returns the results +Returns the results ## PARAMETERS @@ -104,15 +105,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/skype/skype-ps/skype/Get-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md index 75c954aaa7..fb9aee778f 100644 --- a/skype/skype-ps/skype/Get-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsGuestMeetingConfiguration.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsguestmeetingconfiguration -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmeetingconfiguration +applicable: Microsoft Teams title: Get-CsTeamsGuestMeetingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsGuestMeetingConfiguration @@ -107,15 +107,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/skype/skype-ps/skype/Get-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Get-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md index b0daa6a852..c5dbf828bd 100644 --- a/skype/skype-ps/skype/Get-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsguestmessagingconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsguestmessagingconfiguration +applicable: Microsoft Teams title: Get-CsTeamsGuestMessagingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsGuestMessagingConfiguration @@ -106,11 +106,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -118,4 +120,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md similarity index 62% rename from skype/skype-ps/skype/Get-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md index 827ab22c0a..4df635ab40 100644 --- a/skype/skype-ps/skype/Get-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsIPPhonePolicy.md @@ -1,115 +1,109 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsipphonepolicy -applicable: Skype for Business Online -title: Get-CsTeamsIPPhonePolicy -author: tonywoodruff -ms.author: anwoodru -ms.reviewer: kponnus -manager: sandrao -schema: 2.0.0 ---- - -# Get-CsTeamsIPPhonePolicy - -## SYNOPSIS - -Get-CsTeamsIPPhonePolicy allows IT Admins to view policies for IP Phone experiences in Microsoft Teams - -## SYNTAX - -``` -Get-CsTeamsIPPhonePolicy [-LocalStore] [[-Identity] ] [-Tenant ] [-Filter ] - -``` - -## DESCRIPTION - -Returns information about the Teams IP Phone Policies configured for use in your organization. Teams IP phone policies enable you to configure the different sign-in experiences based upon the function the device is performing; example: common area phone. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsIPPhonePolicy -identity CommonAreaPhone -``` - -Retrieves the IP Phone Policy with name "CommonAreaPhone". - - -## PARAMETERS - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". - -```yaml -Type: String - -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Internal Microsoft Use Only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsipphonepolicy +applicable: Microsoft Teams +title: Get-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Get-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Get-CsTeamsIPPhonePolicy allows IT Admins to view policies for IP Phone experiences in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsIPPhonePolicy [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter +``` +Get-CsTeamsIPPhonePolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] +``` + +## DESCRIPTION + +Returns information about the Teams IP Phone Policies configured for use in your organization. Teams IP phone policies enable you to configure the different sign-in experiences based upon the function the device is performing; example: common area phone. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsIPPhonePolicy -identity CommonAreaPhone +``` + +Retrieves the IP Phone Policy with name "CommonAreaPhone". + +## PARAMETERS + +### -Identity +Specify the unique name of the TeamsIPPhonePolicy that you would like to retrieve. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +Internal Microsoft use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..8c4debe867 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,100 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Get-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS + +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMediaConnectivityPolicy [-Identity ] [] +``` + +### Filter + +```powershell +Get-CsTeamsMediaConnectivityPolicy [-Filter ] [] +``` + +## DESCRIPTION + +This cmdlet retrieves all Teams media connectivity policies for the current tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMediaConnectivityPolicy + +Identity DirectConnection +-------- ---------------- +Tag:Test Enabled +``` + +This example retrieves the Teams media connectivity policies and shows the result as identity tag and "DirectConnection" value. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Media Connectivity Policy. + +```yaml +Type: String +Parameter Sets: Identity +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 + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) + +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md index da93dca1f3..85ecd6cb9c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy +applicable: Microsoft Teams title: Get-CsTeamsMediaLoggingPolicy author: LeoKuhorev ms.author: leokukharau -manager: saurk +manager: shalages schema: 2.0.0 --- @@ -21,14 +21,13 @@ Returns information about the Teams Media Logging policy. ### Identity (Default) ``` -Get-CsTeamsMediaLoggingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] - [] +Get-CsTeamsMediaLoggingPolicy [[-Identity] ] [] ``` ### Filter ``` -Get-CsTeamsMediaLoggingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +Get-CsTeamsMediaLoggingPolicy [-Filter ] [] ``` ## DESCRIPTION @@ -69,7 +68,7 @@ Use the "Global" Identity if you wish to retrieve the policy set for the entire Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 2 @@ -77,24 +76,6 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - -### -MsftInternalProcessingMode - -Internal Microsoft use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Filter Enables using wildcards when specifying the policy (or policies) to be retrieved. @@ -104,7 +85,7 @@ Note that you cannot use both the Filter and the Identity parameters in the same Type: String Parameter Sets: Filter Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -127,4 +108,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Grant-CsTeamsMediaLoggingPolicy](/powershell/module/teams/grant-csteamsmedialoggingpolicy) +[Grant-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..d7a61ce63f --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Get-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# Get-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMeetingBrandingPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsMeetingBrandingPolicy [-Filter ] [] +``` + +## DESCRIPTION +The `Get-CsTeamsMeetingBrandingPolicy` cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. + +## EXAMPLES + +### Return all branding policies +```powershell +PS C:\> Get-CsTeamsMeetingBrandingPolicy +``` + +In this example, the command returns a collection of all the teams meeting branding policies configured for use in your organization. + +### Return specified policy +```powershell +PS C:\> CsTeamsMeetingBrandingPolicy -Identity "policy test2" +``` + +In this example, the command returns the meeting branding policy that has an **Identity** `policy test 2`. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: `-Identity global`. If this parameter is omitted, then all the meeting branding policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +## OUTPUTS + +### TeamsMeetingBrandingPolicy.Cmdlets.TeamsMeetingBrandingPolicy + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md index b798852881..973021d356 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastConfiguration.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsmeetingbroadcastconfiguration -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastconfiguration +applicable: Microsoft Teams title: Get-CsTeamsMeetingBroadcastConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsMeetingBroadcastConfiguration @@ -115,15 +115,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md index 58110b7e7d..0b2ca7c3cd 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBroadcastPolicy.md @@ -1,16 +1,15 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsmeetingbroadcastpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: Get-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- - # Get-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS @@ -114,15 +113,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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/skype/skype-ps/skype/Get-CsTeamsMeetingConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md index 22b226a019..3cd9448904 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsmeetingconfiguration -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingconfiguration +applicable: Microsoft Teams title: Get-CsTeamsMeetingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsMeetingConfiguration @@ -112,8 +112,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md similarity index 86% rename from skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md index a1e14e59dd..3679deb1f5 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy +applicable: Microsoft Teams title: Get-CsTeamsMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsMeetingPolicy @@ -43,7 +43,6 @@ Get-CsTeamsMeetingPolicy In Example 1, Get-CsTeamsMeetingPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. - ### -------------------------- Example 2 -------------------------- ```powershell Get-CsTeamsMeetingPolicy -Identity SalesPolicy @@ -71,8 +70,7 @@ NewMeetingRecordingExpirationDays : 60 ``` The above command returns expiration date setting currently applied on TMR. For more details, see: -[Auto-expiration of Teams meeting recordings](https://docs.microsoft.com/microsoftteams/cloud-recording#auto-expiration-of-teams-meeting-recordings). - +[Auto-expiration of Teams meeting recordings](https://learn.microsoft.com/microsoftteams/cloud-recording#auto-expiration-of-teams-meeting-recordings). ## PARAMETERS @@ -135,11 +133,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -147,4 +147,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md new file mode 100644 index 0000000000..f5121f5202 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsMeetingTemplateConfiguration +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplateConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsMeetingTemplateConfiguration + +## SYNOPSIS +This cmdlet fetches the custom meeting templates stored on the tenant. + +## SYNTAX + +```powershell +Get-CsTeamsMeetingTemplateConfiguration [[-Identity] ] [] +``` + +## DESCRIPTION +Fetches the list of custom templates on the tenant. Each template object contains its list of meeting options, the name of the template, and its ID. + +## EXAMPLES + +### Example 1 - Fetching all custom meeting templates on the tenant + +```powershell +PS C:\> Get-CsTeamsMeetingTemplateConfiguration + +Identity : Global +TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, + customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5, + customtemplate_0b9c1f57-01ec-4b8a-b4c2-08bd1c01e6ba...} +Description : The `TeamsMeetingTemplates` property contains the meeting template details: + +TeamsMeetingOptions : {SelectedSensitivityLabel, AutoAdmittedUsers, AllowPstnUsersToBypassLobby, + EntryExitAnnouncementsEnabled...} +Description : Custom Template 1 +Name : customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969 +Category : + +TeamsMeetingOptions : {AutoRecordingEnabled, AllowMeetingChat, PresenterOption} +Description : Custom Template 2 +Name : customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5 +Category : +``` + +Fetches all the custom templates on the tenant. + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the configuration. + +Note: This configuration is read only and will only have the Global instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..22af122659 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hide meeting templates from users and groups. + +## SYNTAX + +### Identity +```powershell +Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter ] [] +``` + +## DESCRIPTION +Fetches the instances of the policy. Each policy object contains a property called `HiddenMeetingTemplates`.This array contains the list of meeting template IDs that will be hidden by that instance of the policy. + +## EXAMPLES + +### Example 1 - Fetching all policies + +```powershell +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy + +Identity : Global +HiddenMeetingTemplates : {} +Description : + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : + +Identity : Tag:dashbrd test +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : test + +Identity : Tag:Default +HiddenMeetingTemplates : {} +Description : +``` + +Fetches all the policy instances currently available. + +### Example 2 - Fetching a specific policy using its identity + +```powershell +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +Fetches an instance of a policy with known identity. + +### Example 3 - Fetching policies using regex + +```powershell +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy -Filter *Foo* + +Identity : Tag:Foobar +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} +Description : +``` + +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md similarity index 84% rename from skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md index 90ee3d066b..8f998b1d2f 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMessagingPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy +applicable: Microsoft Teams title: Get-CsTeamsMessagingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsMessagingPolicy @@ -105,11 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -117,4 +119,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md index 377581d0e8..3a147f9743 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMobilityPolicy.md @@ -1,90 +1,89 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsmobilitypolicy -applicable: Skype for Business Online -title: Get-CsTeamsMobilityPolicy -schema: 2.0.0 -manager: ritikag -ms.reviewer: ritikag ---- - - -# Get-CsTeamsMobilityPolicy - -## SYNOPSIS -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsMobilityPolicy [-Tenant ] [[-Identity] ] [-LocalStore] - [] -``` - -### Filter -``` -Get-CsTeamsMobilityPolicy [-Tenant ] [-Filter ] [-LocalStore] [] -``` - -## DESCRIPTION -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -The Get-CsTeamsMobilityPolicy cmdlet allows administrators to get all teams mobility policies. - -NOTE: Please note that this cmdlet was deprecated and then removed from this PowerShell module. This reference will continue to be listed here for legacy purposes. - - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-CsTeamsMobilityPolicy -``` -Retrieve all teams mobility policies that are available in your organization - -## PARAMETERS - -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the unique name of a policy you would like to retrieve - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -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 +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Get-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Get-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsMobilityPolicy [-Tenant ] [[-Identity] ] [-LocalStore] + [] +``` + +### Filter +``` +Get-CsTeamsMobilityPolicy [-Tenant ] [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The Get-CsTeamsMobilityPolicy cmdlet allows administrators to get all teams mobility policies. + +NOTE: Please note that this cmdlet was deprecated and then removed from this PowerShell module. This reference will continue to be listed here for legacy purposes. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMobilityPolicy +``` +Retrieve all teams mobility policies that are available in your organization + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return a collection of all the per-user policies, use this syntax: -Filter "tag:". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the unique name of a policy you would like to retrieve + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +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/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md new file mode 100644 index 0000000000..73ca7780ac --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsMultiTenantOrganizationConfiguration.md @@ -0,0 +1,50 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Get-CsTeamsMultiTenantOrganizationConfiguration +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +author: samlyu +ms.author: samlyu +--- + +# Get-CsTeamsMultiTenantOrganizationConfiguration + +## SYNOPSIS + +This cmdlet retrieves all tenant settings for Multi-tenant Organizations + +## SYNTAX + +``` +Get-CsTeamsMultiTenantOrganizationConfiguration [] +``` + +## DESCRIPTION + +The Get-CsTeamsMultiTenantOrganizationConfiguration cmdlet enables Teams meeting administrators to retrieve the Multi-Tenant Organization settings for their tenant. This includes the *CopilotFromHomeTenant* field, which specifies whether users in a Multi-Tenant Organization are allowed to utilize their Copilot license from their home tenant during cross-tenant meetings. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMultiTenantOrganizationConfiguration +``` + +Retrieves tenant's Multi-tenant Organization Configuration, including CopilotFromHomeTenant. + +## 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 + +[Set-CsTeamsMultiTenantOrganizationConfiguration](Set-CsTeamsMultiTenantOrganizationConfiguration.md) diff --git a/skype/skype-ps/skype/Get-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md similarity index 75% rename from skype/skype-ps/skype/Get-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md index bb643f0b52..f098d86971 100644 --- a/skype/skype-ps/skype/Get-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsnetworkroamingpolicy -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnetworkroamingpolicy +applicable: Microsoft Teams title: Get-CsTeamsNetworkRoamingPolicy author: TristanChen-msft ms.author: jiaych -ms.reviewer: +ms.reviewer: manager: mreddy schema: 2.0.0 --- @@ -19,13 +19,18 @@ Get-CsTeamsNetworkRoamingPolicy allows IT Admins to view policies for the Networ ## SYNTAX +### Identity (Default) ``` -Get-CsTeamsNetworkRoamingPolicy [-Tenant ] [[-Identity] ] +Get-CsTeamsNetworkRoamingPolicy [-Identity ] + [-MsftInternalProcessingMode ] + [] ``` ### Filter ``` -Get-CsTeamsNetworkRoamingPolicy [-Tenant ] [-Filter ] +Get-CsTeamsNetworkRoamingPolicy [-Filter ] + [-MsftInternalProcessingMode ] + [] ``` ## DESCRIPTION @@ -33,9 +38,9 @@ Returns information about the Teams Network Roaming Policies configured for use The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. -More on the impact of bit rate setting on bandwidth can be found [here](https://docs.microsoft.com/microsoftteams/prepare-network). +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). -To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. +To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. ## EXAMPLES @@ -61,22 +66,8 @@ Unique identifier of the policy to be returned. If this parameter is omitted, then all the Teams Network Roaming Policies configured for use in your organization will be returned. ```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant - -```yaml -Type: Guid -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False @@ -91,7 +82,7 @@ Enables you to use wildcard characters when indicating the policy (or policies) ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Filter Aliases: Required: False @@ -101,10 +92,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore +### -MsftInternalProcessingMode +Internal Microsoft use only. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -115,6 +107,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 diff --git a/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md new file mode 100644 index 0000000000..95ac82e696 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsNotificationAndFeedsPolicy.md @@ -0,0 +1,100 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsnotificationandfeedspolicy +title: Get-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Retrieves information about the Teams Notification and Feeds policy configured for use in the tenant. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter +```powershell +Get-CsTeamsNotificationAndFeedsPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsNotificationAndFeedsPolicy +``` + +The command shown above returns information of all Teams NotificationAndFeedsPolicy that have been configured for use in the tenant. + +## PARAMETERS + +### -Filter +A filter that is not expressed in the standard wildcard language. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..f4c168932c --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Get-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Get-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsRecordingRollOutPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsRecordingRollOutPolicy [-Filter ] [] +``` + +## DESCRIPTION + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The Get-CsTeamsRecordingRollOutPolicy cmdlet enables you to return information about all the CsTeamsRecordingRollOutPolicy that have been configured for use in your organization. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsRecordingRollOutPolicy +``` + +In Example 1, Get-CsTeamsRecordingRollOutPolicy is called without any additional parameters; this returns a collection of all the CsTeamsRecordingRollOutPolicy configured for use in your organization. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. +If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..d0da8be66e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,99 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsroomvideoteleconferencingpolicy +title: Get-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Room Video TeleConferencing policies. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsTeamsRoomVideoTeleConferencingPolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The name the tenant admin gave to the Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md b/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md new file mode 100644 index 0000000000..74dc4c20ca --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSettingsCustomApp.md @@ -0,0 +1,83 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp +title: Get-CsTeamsSettingsCustomApp +schema: 2.0.0 +--- + +# Get-CsTeamsSettingsCustomApp + +## SYNOPSIS +Get the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Get-CsTeamsSettingsCustomApp [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide app settings page of Teams Admin Center. The command can get the current value of this switch. If the switch is enabled, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsSettingsCustomApp + +IsSideloadedAppsInteractionEnabled +---------------------------------- + False +``` + +Get the value of Custom Apps Setting. The value in the example is False, so custom apps are unavailable in the organization's app store. + +## 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 +[Set-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..817189ce6e --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,114 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Get-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Get-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Use the Get-CsTeamsSharedCallingRoutingPolicy cmdlet to get Teams shared calling routing policy information. +Teams shared calling routing policy is used to configure shared calling. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsSharedCallingRoutingPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsSharedCallingRoutingPolicy [-Filter ] [] +``` + +## DESCRIPTION + +TeamsSharedCallingRoutingPolicy is used to configure shared calling. + +## EXAMPLES + +### Example 1 +``` +Get-CsTeamsSharedCallingRoutingPolicy +``` +The command shown in Example 1 returns information for all the Teams shared calling routing policies configured for use in the organization. + +### Example 2 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Identity "Seattle" +``` +In Example 2, information is returned for a single Teams shared calling routing policy; the policy with Identity Seattle. + +### Example 3 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Filter "tag:*" +``` +The command shown in Example 3 returns information about all the Teams shared calling routing policies configured at the per-user scope. + +### Example 4 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Identity Global +``` +The command shown in Example 4 returns information about the Global policy instance. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams shared calling routing policy to be retrieved. + +You cannot use wildcard characters when specifying the Identity. If neither the Identity nor the Filter parameters are specified, then Get-CsTeamsSharedCallingRoutingPolicy +returns all the Teams shared calling routing policies configured for use in the organization. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +To return a collection of all the per-user policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +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 +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md new file mode 100644 index 0000000000..e669a7e816 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsAppPolicy.md @@ -0,0 +1,107 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsapppolicy +title: Get-CsTeamsShiftsAppPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Returns information about the Teams Shifts App policies that have been configured for use in your organization. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsShiftsAppPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsShiftsAppPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsShiftsAppPolicy +``` + +Lists any available Teams Shifts Apps Policies. + +## PARAMETERS + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique Identity assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +{{ Fill MsftInternalProcessingMode Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..5bfed6ecbd --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -0,0 +1,268 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Get-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet returns the list of existing workforce management (WFM) connections. It can also return the configuration details for a given WFM connection. + +## SYNTAX + +### Get (Default) +```powershell +Get-CsTeamsShiftsConnection [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### Get1 +```powershell +Get-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnection -InputObject [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +## DESCRIPTION + +This cmdlet returns the list of existing connections. It can also return the configuration details for a given connection. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsShiftsConnection | Format-List +``` +```output +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta4 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : My connection 1 +State : Active +TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : My connection 2 +State : Active +TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 +``` + +Returns the list of connections. + +### Example 2 +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId a2d1b091-5140-4dd2-987a-98a8b5338744 +PS C:\> $connection.ToJsonString() +``` +```output +{ + "connectorSpecificSettings": { + "apiUrl": "https://www.contoso.com/api", + "ssoUrl": "https://www.contoso.com/sso", + "clientId": "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + }, + "id": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-000000000000", + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "name": "My connection 2", + "etag": "\"3100fd6e-0000-0400-0000-642ea7840000\"", + "createdDateTime": "2023-04-06T11:05:39.8790000Z", + "lastModifiedDateTime": "2023-04-06T11:05:39.8790000Z", + "state": "Active" +} +``` +Returns the connection with the specified -ConnectionId. + +## PARAMETERS + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The connection ID. + +```yaml +Type: String +Parameter Sets: Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) + +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md index cd27ad8d12..b236e9c29c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionConnector author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector schema: 2.0.0 --- @@ -29,12 +29,21 @@ This cmdlet shows the available list of Shifts Connectors that can be used to sy ### Example 1 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionConnector +PS C:\> Get-CsTeamsShiftsConnectionConnector | Format-List ``` ``` -Id Name SupportedScenario Version WfiSupportedScenario --- ---- ----------------- ------- -------------------- -6A51B888-FF44-4FEA-82E1-839401E9CD74 Contoso V1 {Shift, SwapRequest, UserShiftPreferences, OpenShift...} 2020.3 - 2021.1 {SwapRequest, OpenShiftRequest, TimeOffRequest} +Id : 6A51B888-FF44-4FEA-82E1-839401E9CD74 +Name : Contoso V1 +SupportedSyncScenarioOfferShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioOpenShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioOpenShiftRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioShift : {Disabled, FromWfmToShifts} +SupportedSyncScenarioSwapRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeCard : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioTimeOff : {Disabled, FromWfmToShifts} +SupportedSyncScenarioTimeOffRequest : {Disabled, FromWfmToShifts, TwoWay} +SupportedSyncScenarioUserShiftPreference : {Disabled, FromWfmToShifts, TwoWay} +Version : 2020.3 - 2021.1 ``` Get the list of Shifts Connectors available on the tenant. @@ -51,8 +60,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md index 89fc8ec62a..adf41720e0 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionErrorReport author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionerrorreport schema: 2.0.0 --- @@ -17,12 +17,27 @@ This cmdlet returns the list of all the team mapping error reports. It can also ## SYNTAX -``` -Get-CsTeamsShiftsConnectionErrorReport [[-Activeness] ] [[-ConnectorInstanceId] ] [[-TeamId] ] [[-Operation] ] [[-Code] ] [[-Procedure] ] [[-Before] ] [[-After] ] [] +### Get (Default) +```powershell +Get-CsTeamsShiftsConnectionErrorReport [-Activeness ] [-After ] [-Before ] + [-Code ] [-ConnectionId ] [-ConnectorInstanceId ] [-Operation ] + [-Procedure ] [-TeamId ] [-Authorization ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` +### Get1 +```powershell +Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] ``` -Get-CsTeamsShiftsConnectionErrorReport [[-ErrorReportId] ] [] + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionErrorReport -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ## DESCRIPTION @@ -36,25 +51,47 @@ This cmdlet returns the list of existing team mapping error reports. It can also PS C:\> Get-CsTeamsShiftsConnectionErrorReport ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt revisitIntervalInMinutes ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- -- -UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2215 Unable to map all users: 10 succeeded, 1 failed for Graph users, and 15 failed for Wfm users. UserMappingHandler {9, 0, 39} MapUsers 15 -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. UserMappingHandler {5, 0, 19} MapUsers 15 -UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 740 Unable to map all users: 12 succeeded, 3 failed for Graph users, and 11 failed for Wfm users. UserMappingHandler {1, 2, 24} MapUsers 15 -UserMappingError 11/30/2021 11:55:43 PM en-US d0b7311f-823d-44e0-9171-f30eb6869335 2219 Unable to map all users: 9 succeeded, 5 failed for Graph users, and 18 failed for Wfm users. UserMappingHandler {7, 1, 37} MapUsers 15 -UserMappingError 11/30/2021 11:55:46 PM en-US e980e667-65b3-4b00-b756-fbf974537ee9 2218 Unable to map all users: 22 succeeded, 4 failed for Graph users, and 19 failed for Wfm users. UserMappingHandler {11, 2, 1} MapUsers 15 +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +WFMAuthError 30/09/2022 14:14:08 en-US False WFMAuthErrorMessageType 74091f69-29b7-4884-aab9-ee5d705f36e3 1042 The workforce management system account credentials you've ... +WFMAuthError 17/10/2022 19:42:15 en-US False WFMAuthErrorMessageType b0d04444-d80b-490a-a573-ae3bb7f871bc 40 The workforce management system account credentials you've ... +WFMAuthError 17/10/2022 20:27:31 en-US False WFMAuthErrorMessageType 91ca35d9-1abc-4ded-bcda-dbf58a155930 94 The workforce management system account credentials you've ... +GraphUserAuthError 18/10/2022 04:46:57 en-US False GraphUserAuthErrorMessageType 4d26df1c-7133-4477-9266-5d7ffb70aa88 0 Authentication failed. Ensure that you've entered valid cre... +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD us... +BatchTeamMappingError 06/04/2023 15:24:22 en-US False BatchTeamMappingErrorMessageType bf1bc3ea-1e40-483b-b6cc-669f22f24c48 1 This designated actor profile doesn't have team ownership p... ``` Returns the list of all the error reports. ### Example 2 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 18b3e490-e6ed-4c2e-9925-47e36609dff3 +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -ErrorReportId 74091f69-29b7-4884-aab9-ee5d705f36e3 | Format-List ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt RevisitIntervalInMinute RevisitedAt ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- ----------------------- ------- -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. UserMappingHandler {5, 0, 19} MapUsers 15 +Code : WFMAuthError +ConnectionId : +CreatedAt : 30/09/2022 14:14:08 +Culture : en-US +ErrorNotificationSent : False +ErrorType : WFMAuthErrorMessageType +Id : 74091f69-29b7-4884-aab9-ee5d705f36e3 +IntermediateIncident : 1042 +Message : The workforce management system account credentials you've provided are invalid or this account doesn't have the required permissions. +Operation : SyncSwapShiftRequestCommand +Parameter : +Procedure : ExecuteAsync +ReferenceLink : +ResolvedAt : +ResolvedNotificationSentOn : +RevisitIntervalInMinute : 1440 +RevisitedAt : +ScheduleSequenceNumber : 310673843 +Severity : Critical +TeamId : +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +TotalIncident : 1042 +Ttl : 2505600 +WfmConnectorInstanceId : WCI-6f8eb424-c347-46b4-a50b-118af8d3d546 ``` Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. @@ -64,12 +101,12 @@ Returns the error report with ID `18b3e490-e6ed-4c2e-9925-47e36609dff3`. PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Code UserMappingError ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message ----- --------- ------- -- -------------------- ------- -UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2217 Unable to map all users: 9 succeeded, 5 failed for Graph users, and 8 failed for Wfm users. -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. -UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 1776 Unable to map all users: 6 succeeded, 2 failed for Graph users, and 3 failed for Wfm users. -UserMappingError 11/30/2021 11:55:43 PM en-US d0b7311f-823d-44e0-9171-f30eb6869335 5319 Unable to map all users: 7 succeeded, 3 failed for Graph users, and 2 failed for Wfm users. +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and ... ``` Returns the error report with error code `UserMappingError`. @@ -79,28 +116,28 @@ Returns the error report with error code `UserMappingError`. PS C:\> Get-CsTeamsShiftsConnectionErrorReport -Operation UserMappingHandler ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt RevisitIntervalInMinute ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---------- -------------------- -UserMappingError 11/30/2021 11:54:47 PM en-US ec58cf47-0bb3-4c89-b9a6-e724278b57c9 2217 Unable to map all users: 9 succeeded, 5 failed for Graph users, and 8 failed for Wfm users. UserMappingHandler {9, 0, 39} MapUsers 12/3/2021 8:00:20 PM 15 -UserMappingError 11/30/2021 11:54:47 PM en-US 18b3e490-e6ed-4c2e-9925-47e36609dff3 938 Unable to map all users: 15 succeeded, 2 failed for Graph users, and 12 failed for Wfm users. UserMappingHandler {5, 0, 19} MapUsers 15 -UserMappingError 11/30/2021 11:54:54 PM en-US 52f6e9bf-1258-4c2b-8af2-3aca159e98b3 1776 Unable to map all users: 6 succeeded, 2 failed for Graph users, and 3 failed for Wfm users. UserMappingHandler {1, 2, 24} MapUsers 15 +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 18/10/2022 04:47:15 en-US False UserMappingErrorMessageType 6a90b796-9cda-4cc9-a74c-499de91073f9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:47:28 en-US False UserMappingErrorMessageType 005c4a9d-552e-4ea1-9d6a-c0316d272bc9 0 Mapping failed for some users: 3 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:48:25 en-US False UserMappingErrorMessageType 841e00b5-c4e5-4e24-89d2-703d79250516 0 Mapping failed for some users: 4 succeeded, 0 failed AAD user(s) and ... +UserMappingError 18/10/2022 04:54:05 en-US False UserMappingErrorMessageType 0e10d036-c071-4db2-9cac-22e520f929d9 0 Mapping failed for some users: 5 succeeded, 0 failed AAD user(s) and ... ``` Returns the error report with operation `UserMappingHandler`. ### Example 5 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2021-12-01T19:11:39.073Z +PS C:\> Get-CsTeamsShiftsConnectionErrorReport -After 2022-12-12T19:11:39.073Z ``` ```output -Code CreatedAt Culture Id IntermediateIncident Message Operation Parameter Procedure ResolvedAt ----- --------- ------- -- -------------------- ------- --------- --------- --------- ---- -UserMappingError 12/1/2021 3:47:55 PM en-US 82e59bc0-fb69-49f4-830b-19ac3b1f66d7 4796 Unable to map all users: 6 succeeded, 2 failed for Graph users, and 3 failed for Wfm users. UserMappingHandler {4, 0, 20} MapUsers -UserMappingError 12/1/2021 11:04:34 PM en-US f5423691-4fc7-46db-b962-fbcad322c56d 12 Unable to map all users: 9 succeeded, 3 failed for Graph users, and 5 failed for Wfm users. UserMappingHandler {13, 2, 12} MapUsers -UserMappingError 12/2/2021 4:33:06 AM en-US 595f7789-0254-4a11-841d-d9b062515d2f 4383 Unable to map all users: 4 succeeded, 5 failed for Graph users, and 8 failed for Wfm users. UserMappingHandler {4, 0, 20} MapUsers +Code ConnectionId CreatedAt Culture ErrorNotificationSent ErrorType Id IntermediateIncident Message +---- ------------ --------- ------- --------------------- --------- -- -------------------- ------- +UserMappingError 26/01/2023 14:42:27 en-US True UserMappingErrorMessageType d7ab9ab4-b60c-44d3-8c12-d8ee64a67ce8 172 Mapping failed for some users: 1 succeeded, 2 failed AAD us... +WFMAuthError 26/01/2023 16:08:31 en-US False WFMAuthErrorMessageType 7adc3e4e-124e-4613-855c-9ac1b338400a 1 The workforce management system account credentials you've ... ``` -Returns the error report created after `2021-12-01T19:11:39.073Z`. +Returns the error report created after `2022-12-12T19:11:39.073Z`. ## PARAMETERS @@ -139,6 +176,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId + +The UUID of a WFM connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConnectorInstanceId The UUID of a connector instance. @@ -251,6 +304,125 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```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). @@ -262,4 +434,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Disable-CsTeamsShiftsConnectionErrorReport](Disable-CsTeamsShiftsConnectionErrorReport.md) +[Disable-CsTeamsShiftsConnectionErrorReport](https://learn.microsoft.com/powershell/module/teams/disable-csteamsshiftsconnectionerrorreport) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md index 725d1378cd..9cae80f516 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -1,24 +1,40 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Get-CsTeamsShiftsConnectionInstance -author: gucsun -ms.author: gucsun -manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance +author: leonardospina +ms.author: lespina +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance schema: 2.0.0 --- # Get-CsTeamsShiftsConnectionInstance ## SYNOPSIS - This cmdlet returns the list of existing connection instances. It can also return the configuration details for a given connection instance. ## SYNTAX +### Get (Default) +``` +Get-CsTeamsShiftsConnectionInstance [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### Get1 +``` +Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity ``` -Get-CsTeamsShiftsConnectionInstance [[-ConnectorInstanceId] ] [] +Get-CsTeamsShiftsConnectionInstance -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ## DESCRIPTION @@ -29,43 +45,209 @@ This cmdlet returns the list of existing connections. It can also return the con ### Example 1 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionInstance +PS C:\> Get-CsTeamsShiftsConnectionInstance | Format-List ``` ```output -ConnectorAdminEmail DesignatedActorId EnabledConnectorScenario EnabledWfiScenario Etag Id Name SyncFrequencyInMin TenantId -------------------- ----------------- ------------------------ ------------------ ---- -- ---- ------------------ -------- -user@contoso.com 12345fa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, UserShiftPreferences, OpenShift...} {Shift, TimeOffRequest} "1d004f54-0000-0400-0000-60ce37120000" WCI-01c84e58-9a03-4e56-82f1-6b224132cad8 Test connector instance-1 10 dfd24b34-ccb0-47e1-bdb... -user1@contoso.com 12345faf-fd37-4a4d-ab25-ba0b037cb567 {Shift, SwapRequest, OpenShift, OpenShiftRequest...} {Shift, SwapRequest, OpenShift, TimeOff...} "21007c43-0000-0400-0000-60d061300000" WCI-0e2af164-1dcf-4854-8551-631aeda3b437 Test connector instance-2 10 dfd24b34-ccb0-47e1-bdb... -user2@contoso.com 123451a9-e74b-4ff0-afe8-ff9dbe824e7f {Shift, SwapRequest, OpenShift, OpenShiftRequest...} {Shift, SwapRequest, OpenShift, TimeOff...} "2100d271-0000-0400-0000-60d07d980000" WCI-8293ff48-f41a-4f00-8cb9-75ac7a01f6d5 Test connector instance-3 10 dfd24b34-ccb0-47e1-bdb... -user3@contoso.com 12345fa7-e92b-40fb-99a7-2d23b3404712 {Shift, SwapRequest, OpenShift, OpenShiftRequest...} {Shift, SwapRequest, OpenShift, TimeOff...} "23005736-0000-0400-0000-60d10a990000" WCI-922cb572-369d-42d2-969a-d4927cd3683b Test connector instance-4 10 dfd24b34-ccb0-47e1-bdb... -user4@contoso.com 12345b9a-6161-4f6a-9067-9ec3eb881e56 {Shift, SwapRequest, UserShiftPreferences, OpenShift...} {Shift, SwapRequest, UserShiftPreferences, OpenShift...} "2300589a-0000-0400-0000-60d132270000" WCI-da788d04-1bd2-48b1-a261-1dd80bde86db Test connector instance-5 10 dfd24b34-ccb0-47e1-bdb... + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {testAdmin@contoso.com} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:53:59 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aaf3acd231 +Etag : "4f00c221-0000-0400-0000-642ff6480000" +Id : WCI-b58d7a98-ab2c-473f-99a5-e0627d54c062 +LastModifiedDateTime : 07/04/2023 10:53:59 +Name : My connection instance 1 +State : Active +SyncFrequencyInMin : 10 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : FromWfmToShifts +SyncScenarioTimeCard : FromWfmToShifts +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : FromWfmToShifts +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_2ab21992-b9b1-464a-b9cd-e0de1fac95b1 + +ConnectionId : a2d1b091-5140-4dd2-987a-98a8b5338744 +ConnectorAdminEmail : {} +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +CreatedDateTime : 07/04/2023 10:54:01 +DesignatedActorId : ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231 +Etag : "4f005d22-0000-0400-0000-642ff64a0000" +Id : WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +LastModifiedDateTime : 07/04/2023 10:54:01 +Name : My connection instance 2 +State : Active +SyncFrequencyInMin : 30 +SyncScenarioOfferShiftRequest : FromWfmToShifts +SyncScenarioOpenShift : FromWfmToShifts +SyncScenarioOpenShiftRequest : FromWfmToShifts +SyncScenarioShift : FromWfmToShifts +SyncScenarioSwapRequest : Disabled +SyncScenarioTimeCard : Disabled +SyncScenarioTimeOff : FromWfmToShifts +SyncScenarioTimeOffRequest : FromWfmToShifts +SyncScenarioUserShiftPreference : Disabled +TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a +WorkforceIntegrationId : WFI_6b225907-b476-4d40-9773-08b86db7b11b ``` Returns the list of connection instances. ### Example 2 ```powershell -PS C:\> Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId "WCI-01c84e59-9a03-4e56-82f1-6b224132cad8" +PS C:\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 +PS C:\> $ci.ToJsonString() ``` ```output -ConnectorAdminEmail DesignatedActorId EnabledConnectorScenario EnabledWfiScenario Etag Id Name SyncFrequencyInMin TenantId WorkforceIntegrationId -------------------- ----------------- ------------------------ ------------------ ---- -- ---- ------------------ -------- ---------------------- -user@contoso.com 12345fa7-e92b-40fb-99a7-2d23b3412345 {Shift, SwapRequest, UserShiftPreferences, OpenShift...} {Shift, TimeOffRequest} "1d004f54-0000-0400-0000-60ce37120000" WCI-01c84e58-9a03-4e56-82f1-6b224132cad8 Test Connector Instance3 10 12345b34-ccb0-47e1-bdb7-e49db9c7c14a WFI_3fd79702-15e4-4c97-9b0e-dd725e92c... +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "Disabled", + "timeCard": "Disabled", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-78F5116E-9098-45F5-B595-1153DF9D6F70", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "My connection instance 2", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" +} ``` - -Returns the connection instance with ID `WCI-01c84e59-9a03-4e56-82f1-6b224132cad8`. +Returns the connection instance with the specified -ConnectorInstanceId. ## PARAMETERS -### -ConnectorInstanceId +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The ID of the connection instance. +### -ConnectorInstanceId +The connector instance id ```yaml Type: String +Parameter Sets: Get1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + Required: False Position: Named Default value: None @@ -78,16 +260,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + ## OUTPUTS +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + ## NOTES ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) - -[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md index d56f25171a..e1910f5da5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionOperation author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation schema: 2.0.0 --- @@ -13,12 +13,22 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet gets the requested batch mapping operation. The batch mapping operation can be submitted by running [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md). +This cmdlet gets the requested batch mapping operation. The batch mapping operation can be submitted by running [New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap). ## SYNTAX +### Get (Default) +```powershell +Get-CsTeamsShiftsConnectionOperation -OperationId [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] ``` -Get-CsTeamsShiftsConnectionOperation -OperationId [] + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionOperation -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ## DESCRIPTION @@ -41,15 +51,74 @@ Returns the details of batch mapping operation with ID `c79131b7-9ecb-484b-a8df- ## PARAMETERS -### -Id +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` +### -OperationId The ID of the batch mapping operation. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None @@ -57,6 +126,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```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). @@ -68,4 +182,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md index 3f7d074fc6..d893f5cf7e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionSyncResult author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionsyncresult schema: 2.0.0 --- @@ -18,7 +18,7 @@ This cmdlet supports retrieving the list of user details in the mapped teams of ## SYNTAX ``` -Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId -TeamId [] +Get-CsTeamsShiftsConnectionSyncResult -ConnectorInstanceId -TeamId -InputObject [] ``` ## DESCRIPTION @@ -46,7 +46,7 @@ Returns the successful and failed users in the team mapping of Teams `12345d29-7 ### -ConnectorInstanceId -The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). ```yaml Type: String @@ -76,6 +76,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +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). @@ -87,4 +103,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md index 5b7e0daae9..7bdc708135 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionTeamMap author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap schema: 2.0.0 --- @@ -18,12 +18,12 @@ This cmdlet supports retrieving the list of team mappings. ## SYNTAX ``` -Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId [] +Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -InputObject [] ``` ## DESCRIPTION -Workforce management (WFM) systems have locations / sites that are mapped to a Microsoft Teams team for synchronization of shifts data. This cmdlet shows the list of mapped teams inside the connection instance. Intance IDs can be found by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). +Workforce management (WFM) systems have locations / sites that are mapped to a Microsoft Teams team for synchronization of shifts data. This cmdlet shows the list of mapped teams inside the connection instance. Instance IDs can be found by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). ## EXAMPLES @@ -32,9 +32,9 @@ Workforce management (WFM) systems have locations / sites that are mapped to a M PS C:\> Get-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-d1addd70-2684-4723-b8f2-7fa2230648c9" ``` ```output -TeamId TeamName WfmTeamId WfmTeamName ------- -------- --------- ----------- -12344689-758c-4598-9206-3e23416da8c2 1000107 +TeamId TeamName TimeZone WfmTeamId WfmTeamName +------ -------- -------- --------- ----------- +12344689-758c-4598-9206-3e23416da8c2 America/Los_Angeles 1000107 ``` Returns the list of team mappings in the instance with ID `WCI-d1addd70-2684-4723-b8f2-7fa2230648c9`. @@ -64,6 +64,20 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +The Identity parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +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). @@ -76,8 +90,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md) - -[Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) +[Remove-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectionteammap) -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md index ae1d6d3b95..f65e7c3eed 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionWfmTeam author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam schema: 2.0.0 --- @@ -17,8 +17,32 @@ This cmdlet supports retrieving the list of available Workforce management (WFM) ## SYNTAX +### Get (Default) +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` -Get-CsTeamsShiftsConnectionWfmTeam -ConnectorInstanceId [] + +### Get1 +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId [-Authorization ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity1 +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -InputObject [-Authorization ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ## DESCRIPTION @@ -52,13 +76,56 @@ Id Name 1000129 Test ``` -Returns the WFM teams in the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. +Returns the WFM teams for the connection instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId "a2d1b091-5140-4dd2-987a-98a8b5338744" +``` +```output +Id Name +-- ---- +1000105 0002 - Bucktown +1000106 0003 - West Town +1000107 0005 - Old Town +1000108 0004 - River North +1000109 0001 - Wicker Park +1000111 2055 +1000112 2056 +1000114 1004 +1000115 1003 +1000116 1002 +1000122 0010 +1000124 0300 +1000125 1000 +1000126 4500 +1000128 0006 - WFM Team 1 +1000129 Test +``` + +Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98a8b5338744`. ## PARAMETERS ### -ConnectorInstanceId -The ID of the connection instance. You can retrive it by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). +The ID of the connection instance. You can retrieve it by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId + +The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). ```yaml Type: String @@ -72,6 +139,126 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: Get1, GetViaIdentity1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity1, GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```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). @@ -83,6 +270,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) +[Get-CsTeamsShiftsConnectionWfmUser](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md index a7f2d6cef5..f32eda9d1a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md @@ -5,7 +5,7 @@ title: Get-CsTeamsShiftsConnectionWfmUser author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmuser schema: 2.0.0 --- @@ -13,17 +13,17 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. ## SYNTAX -``` -Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId -WfmTeamId [] +```powershell +Get-CsTeamsShiftsConnectionWfmUser -ConnectorInstanceId -WfmTeamId -InputObject [] ``` ## DESCRIPTION -This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. +This cmdlet shows the list of Workforce management (WFM) users in a specified WFM team. ## EXAMPLES @@ -49,7 +49,7 @@ Returns the users in the WFM team with ID `1000107` in the connection instances ### -ConnectorInstanceId -The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). +The ID of the connection instance. It can be retrieved by running [Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance). ```yaml Type: String @@ -65,7 +65,7 @@ Accept wildcard characters: False ### -WfmTeamId -The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md). +The Teams team ID. It can be retrieved by running [Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam). ```yaml Type: String @@ -79,6 +79,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: GetViaIdentity +Aliases: + +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). @@ -90,6 +106,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) -[Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) +[Get-CsTeamsShiftsConnectionWfmTeam](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionwfmteam) diff --git a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md index 491e45dbef..05e0a5d12c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-teamsshiftspolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-teamsshiftspolicy +title: Get-CsTeamsShiftsPolicy schema: 2.0.0 --- @@ -9,18 +10,22 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. +This cmdlet allows you to get properties of a TeamsShiftPolicy instance, including user's Teams off shift warning message-specific settings. ## SYNTAX ### Identity (Default) -``` +```powershell Get-CsTeamsShiftsPolicy [[-Identity] ] [] ``` -## DESCRIPTION -This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). +### Filter +```powershell +Get-CsTeamsShiftsPolicy [-Filter ] [] +``` +## DESCRIPTION +This cmdlet allows you to get properties of a TeamsShiftPolicy instance. Use this to get the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). ## EXAMPLES @@ -55,10 +60,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. To return a collection of all the policies, use this syntax: -Filter "tag:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None @@ -66,14 +85,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) -[New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) -[Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) -[Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md new file mode 100644 index 0000000000..bae35132f4 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md @@ -0,0 +1,53 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Get-CsTeamsSipDevicesConfiguration +author: anmandav +ms.author: anmandav +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsSipDevicesConfiguration + +## SYNOPSIS + +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration. + +## SYNTAX + +```powershell +Get-CsTeamsSipDevicesConfiguration [] +``` + +## DESCRIPTION + +This cmdlet is used to retrieve the organization-wide Teams SIP devices configuration which contains settings that are applicable to SIP devices connected to Teams using Teams Sip Gateway. + +To execute the cmdlet, you need to hold a role within your organization such as Global Reader, Teams Administrator, or Teams Communication Administrator. + +## Examples + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsSipDevicesConfiguration + +Identity : Global +BulkSignIn : Enabled +``` + +In this example, the organization has Bulk SignIn enabled for their SIP devices. + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[Set-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..e62879f6a5 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,95 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliance +title: Get-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Get-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsSurvivableBranchAppliance [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsTeamsSurvivableBranchAppliance [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..c978c4c0a6 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,95 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssurvivablebranchappliancepolicy +title: Get-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Get-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-MsftInternalProcessingMode ] + [] +``` + +### Filter + +```powershell +Get-CsTeamsSurvivableBranchAppliancePolicy [-MsftInternalProcessingMode ] [-Filter ] + [] +``` + +## PARAMETERS + +### -Filter + +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..8b48de854b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsTargetingPolicy.md @@ -0,0 +1,111 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy +title: Get-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsTargetingPolicy + +## SYNOPSIS + +The Teams Targeting Policy cmdlets enable administrators to control the type of Tenant tag setting that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsTargetingPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsTargetingPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +The Get-CsTeamsTargetingPolicy cmdlet enables you to return information about all the Tenant tag setting policies that have been configured for use in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsTargetingPolicy -Identity SalesPolicy +``` + +In this example Get-CsTeamsTargetingPolicy is used to return the per-tenant tag policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-tenant policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the tenant tag setting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..783c5f16c2 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy +title: Get-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# Get-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Fetches the TeamsTemplatePermissionPolicy. This policy can be used to hide Teams templates from users and groups. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsTemplatePermissionPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsTemplatePermissionPolicy [-Filter ] [] +``` + +## DESCRIPTION +Fetches the instances of the policy. Each policy object contains a property called `HiddenTemplates`.This array contains the list of Teams template IDs that will be hidden by that instance of the policy. + +## EXAMPLES + +### Example 1 +```powershell +PS >Get-CsTeamsTemplatePermissionPolicy +``` +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Global {com.microsoft.teams.template.CoordinateIncidentResponse} +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +Fetches all the policy instances currently available. + +### Example 2 + +```powershell +PS >Get-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +Fetches an instance of a policy with known identity. + +### Example 3 + +```powershell +PS >Get-CsTeamsTemplatePermissionPolicy -Filter *Foo* +``` +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Filter +This parameter can be used to fetch policy instances based on partial matches on the `Identity` field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Get-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md similarity index 76% rename from skype/skype-ps/skype/Get-CsTeamsTranslationRule.md rename to teams/teams-ps/teams/Get-CsTeamsTranslationRule.md index 005aaeccda..402b525db2 100644 --- a/skype/skype-ps/skype/Get-CsTeamsTranslationRule.md +++ b/teams/teams-ps/teams/Get-CsTeamsTranslationRule.md @@ -1,109 +1,105 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamstranslationrule -applicable: Microsoft Teams -title: Get-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# Get-CsTeamsTranslationRule - -## SYNOPSIS -Cmdlet to get an existing number manipulation rule (or list of rules). - -## SYNTAX - -### Identity (Default) -``` -Get-CsTeamsTranslationRule [[-Identity] ] [] -``` - -### Filter -``` -Get-CsTeamsTranslationRule [-Filter ] [] -``` - -## DESCRIPTION -You can use this cmdlet to get an existing number manipulation rule (or list of rules). The rule can be used, for example, in the settings of your SBC (Set-CSOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System. - -## EXAMPLES - -### Example 1 -```powershell -Get-CsTeamsTranslationRule -``` - -This command will show all translation rules that exist in the tenant. Identity, Name, Description, Pattern, and Translation parameters are listed for each rule. - - -### Example 2 -```powershell -Get-CsTeamsTranslationRule -Identity AddPlus1 -``` - -This command will show Identity, Name, Description, Pattern, and Translation parameters for the "AddPlus1" rule. - - -### Example 3 -```powershell -Get-CsTeamsTranslationRule -Filter 'Add*' -``` - -This command will show Identity, Name, Description, Pattern, and Translation parameters for all rules with Identity starting with Add. - - -## PARAMETERS - -### -Identity -Identifier of the specific translation rule to display. - -```yaml -Type: String -Parameter Sets: (Identity) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -The filter to use against the Identity of translation rules. - -```yaml -Type: String -Parameter Sets: (Filter) -Aliases: -Applicable: Microsoft Teams - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -[New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) - -[Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) - -[Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) - -[Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule +applicable: Microsoft Teams +title: Get-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Get-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to get an existing number manipulation rule (or list of rules). + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsTranslationRule [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsTranslationRule [-Filter ] [] +``` + +## DESCRIPTION +You can use this cmdlet to get an existing number manipulation rule (or list of rules). The rule can be used, for example, in the settings of your SBC (Set-CSOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System. + +## EXAMPLES + +### Example 1 +```powershell +Get-CsTeamsTranslationRule +``` + +This command will show all translation rules that exist in the tenant. Identity, Name, Description, Pattern, and Translation parameters are listed for each rule. + +### Example 2 +```powershell +Get-CsTeamsTranslationRule -Identity AddPlus1 +``` + +This command will show Identity, Name, Description, Pattern, and Translation parameters for the "AddPlus1" rule. + +### Example 3 +```powershell +Get-CsTeamsTranslationRule -Filter 'Add*' +``` + +This command will show Identity, Name, Description, Pattern, and Translation parameters for all rules with Identity starting with Add. + +## PARAMETERS + +### -Identity +Identifier of the specific translation rule to display. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter +The filter to use against the Identity of translation rules. + +```yaml +Type: String +Parameter Sets: (Filter) +Aliases: +Applicable: Microsoft Teams + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md index 8c951298b6..cd8a81e96e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Get-CsTeamsUnassignedNumberTreatment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Get-CsTeamsUnassignedNumberTreatment @@ -15,12 +16,16 @@ schema: 2.0.0 ## SYNOPSIS Displays a specific or all treatments for how calls to an unassigned number range should be routed. - ## SYNTAX -```powershell -Get-CsTeamsUnassignedNumberTreatment [-LocalStore] [[-Identity] ] [-Filter ] [] +### Identity (Default) +``` +Get-CsTeamsUnassignedNumberTreatment [[-Identity] ] [] +``` +### Filter +``` +Get-CsTeamsUnassignedNumberTreatment [-Filter ] [] ``` ## DESCRIPTION @@ -46,8 +51,6 @@ Get-CsTeamsUnassignedNumberTreatment -Filter Ann* ``` This example displays all configured treatments with an Identity starting with Ann. - - ## PARAMETERS ### -Filter @@ -55,8 +58,8 @@ Enables you to limit the returned data by filtering on the Identity attribute. ```yaml Type: String -Parameter Sets: (All) -Aliases: +Parameter Sets: (Filter) +Aliases: Applicable: Microsoft Teams Required: False @@ -64,29 +67,17 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -Identity The Id of the specific treatment to show. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -106,10 +97,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES The cmdlet is available in Teams PS module 2.5.1 or later. - ## RELATED LINKS -[Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) -[New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) -[Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..3bcd814b61 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Get-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Get-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to retrieve the current Teams Update Management policies in the organization. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsUpdateManagementPolicy [[-Identity] ] [-ProgressAction ] + [] +``` + +### Filter +```powershell +Get-CsTeamsUpdateManagementPolicy [-Filter ] [-ProgressAction ] [] +``` + +## DESCRIPTION +The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsUpdateManagementPolicy +``` + +In this example, we retrieve all the existing Teams Update Management policies in the organization. + +## PARAMETERS + +### -Identity +The unique identifier of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +This parameter accepts a wildcard string and returns all policies with identities matching that string. For example, a Filter value of tag:* will return all policies defined at the per-user level. + +```yaml +Type: String +Parameter Sets: Filter +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsUpdateManagementPolicy.Cmdlets.TeamsUpdateManagementPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md new file mode 100644 index 0000000000..7443bce227 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUpgradeConfiguration.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +applicable: Microsoft Teams +title: Get-CsTeamsUpgradeConfiguration +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsTeamsUpgradeConfiguration + +## SYNOPSIS +Returns information related to managing the upgrade to Teams from Skype for Business. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. For Office 365 users, it allows administrators to determine which application end users should use to join Skype for Business meetings. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUpgradeConfiguration [-Tenant ] [[-Identity] ] [-LocalStore] + [] +``` + +### Filter +``` +Get-CsTeamsUpgradeConfiguration [-Tenant ] [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION +TeamsUpgradeConfiguration is used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download the Teams app. It also allows administrators to determine which application Office 365 users should use to join Skype for Business meetings. + +Separate instances of TeamsUpgradeConfiguration exist in Office 365 and Skype for Business Server. + - TeamsUpgradeConfiguration in Office 365 applies to any user who does not have an on-premises Skype for Business account. + - TeamsUpgradeConfiguration in Skype for Business Server can used to manage on-premises users in a hybrid environment. In on-premises, only the DownloadTeams property is available. + +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download the Teams app in the background. This setting is only honored for users on Windows clients, and only if TeamsUpgradePolicy for the user meets either of these conditions: + - NotifySfbUser=true, or + - Mode=TeamsOnly + Otherwise, this setting is ignored. + +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: SkypeMeetingsApp and NativeLimitedClient. "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. This property is only available when configuring TeamsUpgradeConfiguration in Office 365. It is not honored for users homed on-premises in Skype for Business Server. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Get-CsTeamsUpgradeConfiguration +``` + +The above cmdlet lists the properties of TeamsUpgradeConfiguration. + +## PARAMETERS + +### -Identity +{{Fill Identity Description}} + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Do not use + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES +These settings are only honored by newer versions of Skype for Business clients. + +## RELATED LINKS + +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) + +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) + +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md b/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md new file mode 100644 index 0000000000..1da715da85 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsUpgradePolicy.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +applicable: Microsoft Teams +title: Get-CsTeamsUpgradePolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Get-CsTeamsUpgradePolicy + +## SYNOPSIS +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +> [!IMPORTANT] +> It can take up to 24 hours for a change to TeamsUpgradePolicy to take effect. Before then, user presence status may not be correct (may show as **Unknown**). + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsUpgradePolicy [-Tenant ] [[-Identity] ] [-LocalStore] [] +``` + +### Filter +``` +Get-CsTeamsUpgradePolicy [-Tenant ] [-Filter ] [-LocalStore] [] +``` + +## DESCRIPTION +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. This cmdlet returns the set of instances of this policy. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs whether chat, calling, and meeting scheduling functionality are available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. + +NOTES: + - Except for on-premise versions of Skype for Business Server, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet. + - If you are using Skype for Business Server, there are no built-in instances and you'll need to create one. Also, only the NotifySfBUsers property is available. Mode is not present. + - Using TeamsUpgradePolicy in an on-premises environmention requires Skype for Business Server 2015 with CU8 or later. + +You can also find more guidance here: [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). + +## EXAMPLES + +### Example 1: List all instances of TeamsUpgradePolicy (Skype for Business Online) +``` +PS C:\> Get-CsTeamsUpgradePolicy + +Identity : Global +Description : Users can use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : False + +Identity : Tag:UpgradeToTeams +Description : Use Teams Only +Mode : TeamsOnly +NotifySfbUsers : False + +Identity : Tag:Islands +Description : Use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : False +Action : None + +Identity : Tag:IslandsWithNotify +Description : Use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : True + +Identity : Tag:SfBOnly +Description : Use only Skype for Business +Mode : SfBOnly +NotifySfbUsers : False + +Identity : Tag:SfBOnlyWithNotify +Description : Use only Skype for Business +Mode : SfBOnly +NotifySfbUsers : True + +Identity : Tag:SfBWithTeamsCollab +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollab +NotifySfbUsers : False + +Identity : Tag:SfBWithTeamsCollabWithNotify +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollab +NotifySfbUsers : True + +Identity : Tag:SfBWithTeamsCollabAndMeetings +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollabAndMeetings +NotifySfbUsers : False + +Identity : Tag:SfBWithTeamsCollabAndMeetingsWithNotify +Description : Use Skype for Business and use Teams only for group collaboration +Mode : SfBWithTeamsCollabAndMeetings +NotifySfbUsers : True +``` + +List all instances of TeamsUpgradePolicy + +### Example 2: List the global instance of TeamsUpgradePolicy (which applies to all users in a tenant unless they are explicitly assigned an instance of this policy) +``` +PS C:\> Get-CsTeamsUpgradePolicy -Identity Global + +Identity : Global +Description : Users can use either Skype for Business client or Teams client +Mode : Islands +NotifySfbUsers : False + +``` + +List the global instance of TeamsUpgradePolicy + +### Example 3: List all instances of TeamsUpgradePolicy in an on-premises environment +``` +PS C:\> Get-CsTeamsUpgradePolicy -Identity Global + +Identity : Global +Description : Notifications are disabled +NotifySfbUsers : False + +``` + +List all on-premises instances (if any) of TeamsUpgradePolicy. + +## PARAMETERS + +### -Identity +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -Filter +{{Fill Filter Description}} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) + +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) + +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..41be427ab3 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvdipolicy +title: Get-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Get-CsTeamsVdiPolicy [[-Identity] ] [] +``` + +### Filter +```powershell +Get-CsTeamsVdiPolicy [-Filter ] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVdiPolicy +``` + +In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy +``` + +In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"} +``` + +The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md similarity index 90% rename from skype/skype-ps/skype/Get-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md index 415a953bb6..be0b2b593d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsVideoInteropServicePolicy.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsvideointeropservicepolicy -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvideointeropservicepolicy +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Get-CsTeamsVideoInteropServicePolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTeamsVideoInteropServicePolicy @@ -32,7 +32,7 @@ Get-CsTeamsVideoInteropServicePolicy [-Tenant ] [-Filter ] ``` ## DESCRIPTION -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which partner(s) to use for cloud video interop. +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which partner(s) to use for cloud video interop. The Get-CsTeamsVideoInteropServicePolicy cmdlet allows you to identify the pre-constructed policies that you can use in your organization. You can assign this policy to one or more of your users leveraging the Grant-CsTeamsVideoInteropServicePolicy cmdlet. @@ -108,14 +108,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..5d698766b8 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy +title: Get-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +manager: sonaggarwal +author: emmanuelrocha001 +--- + +# Get-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to fetch policy instances of TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsVirtualAppointmentsPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsVirtualAppointmentsPolicy [-Filter ] [] +``` + +## DESCRIPTION +Fetches instances of TeamsVirtualAppointmentsPolicy. Each policy object contains a property called `EnableSmsNotifications`. This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment meeting template. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsVirtualAppointmentsPolicy +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Global True +Tag:sms-enabled True +Tag:sms-disabled False +``` +Fetches all the policy instances currently available. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled True +``` +Fetches an instance of a policy with a known identity. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Filter *sms* +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled True +Tag:sms-disabled False +``` +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Filter +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +### System.String + +## OUTPUTS + +### TeamsVirtualAppointmentsPolicy.Cmdlets.TeamsVirtualAppointmentsPolicy + +## NOTES + +## RELATED LINKS +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md index f6ac560aef..0a73f7a287 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsVoiceApplicationsPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/get-csteamsvoiceapplicationspolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy +title: Get-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 --- @@ -26,8 +27,7 @@ Get-CsTeamsVoiceApplicationsPolicy [-Filter ] ## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - +TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES @@ -49,7 +49,6 @@ Get-CsTeamsVoiceApplicationsPolicy -Filter "tag:*" ``` The command shown in Example 3 returns information about all the Teams voice applications policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". - ## PARAMETERS ### -Identity @@ -77,7 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -Filter Enables you to use wildcards when retrieving one or more Teams voice applications policies. For example, to return all the policies configured at the per-user scope, use this syntax: @@ -98,21 +96,20 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) - -[Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..894f122d6b --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy +title: Get-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Get-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsWorkLoadPolicy [[-Identity] ] [-MsftInternalProcessingMode ] [] +``` + +### Filter + +```powershell +Get-CsTeamsWorkLoadPolicy [-MsftInternalProcessingMode ] [-Filter ] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsWorkLoadPolicy +``` + +Retrieves the Teams Workload Policy instances and shows assigned values. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..2dd5152b3d --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy +title: Get-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# Get-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to fetch policy instances of TeamsWorkLocationDetectionPolicy. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTeamsWorkLocationDetectionPolicy [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTeamsWorkLocationDetectionPolicy [-Filter ] [] +``` + +## DESCRIPTION +Fetches instances of TeamsWorkLocationDetectionPolicy. Each policy object contains a property called `EnableWorkLocationDetection`. This setting allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsWorkLocationDetectionPolicy +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Global False +Tag:wld-policy1 True +Tag:wld-policy2 False +``` +Fetches all the policy instances currently available. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy1 +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy1 True +``` +Fetches an instance of a policy with a known identity. + +### Example 3 +```powershell +PS C:\> Get-CsTeamsWorkLocationDetectionPolicy -Filter *wld* +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy1 True +Tag:wld-policy2 False +``` +The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity. + +Note: _The "Tag:" prefix can be ignored when specifying the identity._ + +## PARAMETERS + +### -Filter +This parameter can be used to fetch policy instances based on partial matches on the Identity field. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +This parameter can be used to fetch a specific instance of the policy. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +### System.String + +## OUTPUTS + +### TeamsWorkLocationDetectionPolicy.Cmdlets.TeamsWorkLocationDetectionPolicy + +## NOTES + +## RELATED LINKS +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/skype/skype-ps/skype/Get-CsTenant.md b/teams/teams-ps/teams/Get-CsTenant.md similarity index 91% rename from skype/skype-ps/skype/Get-CsTenant.md rename to teams/teams-ps/teams/Get-CsTenant.md index cf053a9ade..2558268bcf 100644 --- a/skype/skype-ps/skype/Get-CsTenant.md +++ b/teams/teams-ps/teams/Get-CsTenant.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenant -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenant +applicable: Microsoft Teams title: Get-CsTenant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenant @@ -109,8 +109,8 @@ This parameter is not used with Skype for Business Online and will be deprecated ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -123,7 +123,6 @@ Accept wildcard characters: False **Note:** This parameter has been deprecated from the Teams PowerShell Module version 3.0.0 or later. - Enables you to return data by using Active Directory attributes and without having to specify the full Active Directory distinguished name. For example, to retrieve a tenant by using the tenant display name, use syntax similar to this: @@ -140,8 +139,8 @@ You cannot use both the Identity parameter and the Filter parameter in the same ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -164,8 +163,8 @@ If you do not include either the Identity or the Filter parameter then the `Get- ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -189,8 +188,8 @@ If you set the tenants to 7 but you have only three contacts in your forest, the ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -200,8 +199,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -215,4 +213,3 @@ The `Get-CsTenant` cmdlet accepts pipelined instances of the Microsoft.Rtc.Manag ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Get-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md similarity index 66% rename from skype/skype-ps/skype/Get-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md index 419fe9dfd7..8f125d7c02 100644 --- a/skype/skype-ps/skype/Get-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/teams/Get-CsTenantBlockedCallingNumbers.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers title: Get-CsTenantBlockedCallingNumbers +applicable: Microsoft Teams schema: 2.0.0 +author: serdarsoysal +ms.author: serdars manager: roykuntz -author: jenstrier -ms.author: jenstr --- # Get-CsTenantBlockedCallingNumbers @@ -15,14 +16,24 @@ Use the Get-CsTenantBlockedCallingNumbers cmdlet to retrieve tenant blocked call ## SYNTAX +### Identity (Default) ``` -Get-CsTenantBlockedCallingNumbers [[-Identity] ] [-Tenant ] [-Filter ] [-LocalStore] +Get-CsTenantBlockedCallingNumbers [[-Identity] ] + [-MsftInternalProcessingMode ] + [] +``` + +### Filter +``` +Get-CsTenantBlockedCallingNumbers [-Filter ] + [-MsftInternalProcessingMode ] + [] ``` ## DESCRIPTION Microsoft Direct Routing, Operator Connect and Calling Plans supports blocking of inbound calls from the public switched telephone network (PSTN). This feature allows a tenant-global list of number patterns to be defined so that the caller ID of every incoming PSTN call to the tenant can be checked against the list for a match. If a match is made, an incoming call is rejected. -The tenant blocked calling numbers includes a list of inbound blocked number patterns. Number patterns are managed through the CsInboundBlockedNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. +The tenant blocked calling numbers includes a list of inbound blocked number patterns. Number patterns are managed through the CsInboundBlockedNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. You can also configure a list of number patterns to be exempt from call blocking. Exempt number patterns are managed through the CsInboundExemptNumberPattern commands New, Get, Set, and Remove. @@ -41,27 +52,12 @@ This example returns the tenant global settings for blocked calling numbers. It ## PARAMETERS -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the TenantBlockedCallingNumbers to retrieve. ```yaml -Type: Object -Parameter Sets: (All) +Type: String +Parameter Sets: Identity Aliases: Required: False @@ -71,12 +67,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is reserved for internal Microsoft use. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: Required: False @@ -86,11 +82,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -MsftInternalProcessingMode +Internal Microsoft use only. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: @@ -101,6 +97,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -108,9 +107,10 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) +[Set-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers) -[Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) diff --git a/skype/skype-ps/skype/Get-CsTenantDialPlan.md b/teams/teams-ps/teams/Get-CsTenantDialPlan.md similarity index 57% rename from skype/skype-ps/skype/Get-CsTenantDialPlan.md rename to teams/teams-ps/teams/Get-CsTenantDialPlan.md index c3eccfe278..6981f68fc3 100644 --- a/skype/skype-ps/skype/Get-CsTenantDialPlan.md +++ b/teams/teams-ps/teams/Get-CsTenantDialPlan.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantdialplan -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan +applicable: Microsoft Teams title: Get-CsTenantDialPlan schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,19 +19,19 @@ Use the Get-CsTenantDialPlan cmdlet to retrieve a tenant dial plan. ### Identity (Default) ``` -Get-CsTenantDialPlan [-Tenant ] [[-Identity] ] [-LocalStore] [] +Get-CsTenantDialPlan [[-Identity] ] [] ``` ### Filter ``` -Get-CsTenantDialPlan [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTenantDialPlan [-Filter ] [] ``` ## DESCRIPTION The Get-CsTenantDialPlan cmdlet returns information about one or more tenant dial plans (also known as a location profiles) in an organization. Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied, and whether a prefix must be dialed for external calls. +A tenant dial plan determines such things as which normalization rules are applied. You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information about the normalization rules of a tenant dial plan. @@ -44,8 +44,6 @@ Get-CsTenantDialPlan This example retrieves all existing tenant dial plans. - - ### -------------------------- Example 2 -------------------------- ``` Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 @@ -53,7 +51,6 @@ Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 This example retrieves the tenant dial plan that has an identity of Vt1TenantDialplan2. - ## PARAMETERS ### -Filter @@ -61,9 +58,9 @@ The Filter parameter allows you to limit the number of results based on filters ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Parameter Sets: (Filter) +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -76,60 +73,35 @@ Accept wildcard characters: False The Identity parameter is a unique identifier that designates the name of the tenant dial plan to retrieve. ```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Type: String +Parameter Sets: (Identity) +Aliases: +Applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. ## RELATED LINKS +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/skype/skype-ps/skype/Get-CsTenantFederationConfiguration.md b/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTenantFederationConfiguration.md rename to teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md index 0f2500efb3..8a7b9f790c 100644 --- a/skype/skype-ps/skype/Get-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTenantFederationConfiguration.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantfederationconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration +applicable: Microsoft Teams title: Get-CsTenantFederationConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantFederationConfiguration @@ -42,7 +42,6 @@ The Get-CsTenantFederationConfiguration cmdlet provides a way for administrators This cmdlet can also be used to review the allowed and blocked lists, lists which are used to specify domains that users can and cannot communicate with. However, administrators must use the Get-CsTenantPublicProvider cmdlet in order to see which public IM and presence providers users are allowed to communicate with. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -59,7 +58,6 @@ Get-CsTenantFederationConfiguration | Select-Object -ExpandProperty AllowedDomai In Example 2, information is returned for all the allowed domains found on the federation configuration for the current tenant (This list represents all the domains that the tenant is allowed to federate with). To do this, the command first calls the Get-CsTenantFederationConfiguration cmdlet to return federation information for the specified tenant. That information is then piped to the Select-Object cmdlet, which uses the ExpandProperty to "expand" the property AllowedDomains. Expanding a property simply means displaying all the information stored in that property onscreen, and in an easy-to-read format. - ## PARAMETERS ### -Filter @@ -72,8 +70,8 @@ However, this is valid syntax for the Get-CsTenantFederationConfiguration cmdlet ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -93,8 +91,8 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -109,8 +107,8 @@ This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -136,8 +134,8 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -147,24 +145,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings - ## NOTES - ## RELATED LINKS -[Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) - -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) - +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md b/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md similarity index 63% rename from skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md rename to teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md index bd113828f7..5eab013035 100644 --- a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md @@ -1,35 +1,36 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantlicensingconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantlicensingconfiguration +applicable: Microsoft Teams title: Get-CsTenantLicensingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantLicensingConfiguration ## SYNOPSIS -Indicates whether licensing information for the specified tenant is available in the Lync admin center. +Indicates whether licensing information for the specified tenant is available in the Teams admin center. ## SYNTAX ### Identity (Default) ``` -Get-CsTenantHybridConfiguration [-Tenant ] [[-Identity] ] [-LocalStore] +Get-CsTenantLicensingConfiguration [[-Identity] ] [-MsftInternalProcessingMode ] [] ``` ### Filter ``` -Get-CsTenantHybridConfiguration [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTenantLicensingConfiguration [-MsftInternalProcessingMode ] [-Filter ] + [] ``` ## DESCRIPTION -The Get-CsTenantLicensingConfiguration cmdlet indicates whether licensing information for the specified tenant is available in the Lync admin center. +The Get-CsTenantLicensingConfiguration cmdlet indicates whether licensing information for the specified tenant is available in the Teams admin center. The cmdlet returns information similar to this: Identity : GlobalStatus : Enabled @@ -46,7 +47,6 @@ Get-CsTenantLicensingConfiguration The command shown in Example 1 returns licensing configuration information for the current tenant: - ## PARAMETERS ### -Filter @@ -55,9 +55,9 @@ Because each tenant is limited to a single, global collection of licensing confi ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Parameter Sets: Filter +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -72,9 +72,9 @@ Because each tenant is limited to a single, global collection of licensing setti ```yaml Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Parameter Sets: Identity +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -83,37 +83,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -This parameter is not used with Skype for Business Online. +### -MsftInternalProcessingMode +For internal use only. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose licensing settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return your tenant ID by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -123,22 +99,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Deserialized.Microsoft.Rtc.Management.WritableConfig.Settings.TenantConfiguration.TenantLicensingConfiguration - ## NOTES - ## RELATED LINKS -[Get-CsTenant](Get-CsTenant.md) - +[Get-CsTenant](https://learn.microsoft.com/powershell/module/teams/get-cstenant) diff --git a/skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md b/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md similarity index 80% rename from skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md rename to teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md index 7981432765..23ce62dd9e 100644 --- a/skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantmigrationconfiguration -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration +applicable: Microsoft Teams title: Get-CsTenantMigrationConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantMigrationConfiguration @@ -44,8 +44,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -60,8 +60,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -76,8 +76,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -92,8 +92,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -103,7 +103,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -112,4 +112,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTenantMigrationConfiguration](https://docs.microsoft.com/powershell/module/skype/set-cstenantmigrationconfiguration?view=skype-ps) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md b/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md new file mode 100644 index 0000000000..110a8e54cc --- /dev/null +++ b/teams/teams-ps/teams/Get-CsTenantNetworkConfiguration.md @@ -0,0 +1,127 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkconfiguration +applicable: Microsoft Teams +title: Get-CsTenantNetworkConfiguration +schema: 2.0.0 +ms.reviewer: +--- + +# Get-CsTenantNetworkConfiguration + +## SYNOPSIS +Returns information about the network regions, sites and subnets in the tenant network configuration. Tenant network configuration is used for Location Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Get-CsTenantNetworkConfiguration [[-Identity] ] [] +``` + +### Filter +``` +Get-CsTenantNetworkConfiguration [-Filter ] [] +``` + +## DESCRIPTION +Tenant Network Configuration contains the list of network sites, subnets and regions configured. + +A network site represents a location where your organization has a physical venue, such as offices, a set of buildings, or a campus. Network sites are defined as a collection of IP subnets. + +A best practice for Location Based Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. Each network site must be associated with a network region. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration. + +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. + +Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. + +A network region interconnects various parts of a network across multiple geographic areas. + +A network region contains a collection of network sites. For example, if your organization has many sites located in India, then you may choose to designate "India" as a network region. + +Location-Based Routing is a feature that allows PSTN toll bypass to be restricted for users based on policy and the user's geographic location at the time of an incoming or outgoing PSTN call. + +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in Microsoft 365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTenantNetworkConfiguration +``` +The command shown in Example 1 returns the list of network configuration for the current tenant. + +### Example 2 +```powershell +PS C:\> Get-CsTenantNetworkConfiguration -Identity Global +``` +The command shown in Example 2 returns the network configuration within the scope of Global. + +### Example 3 +```powershell +PS C:\> Get-CsTenantNetworkConfiguration -Filter "global" +``` +The command shown in Example 3 returns the network site that matches the specified filter. + +## PARAMETERS + +### -Filter +Enables you to use wildcard characters when indicating the network configuration (or network configurations) to be returned. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier for the network configuration. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Identity +The Identity of the network configuration. + +### NetworkRegions +The list of network regions of the network configuration. + +### NetworkSites +The list of network sites of the network configuration. + +### Subnets +The list of network subnets of the network configuration. + +### PostalCodes +This parameter is reserved for internal Microsoft use. + +## NOTES + +## RELATED LINKS +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) + diff --git a/skype/skype-ps/skype/Get-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md similarity index 50% rename from skype/skype-ps/skype/Get-CsTenantNetworkRegion.md rename to teams/teams-ps/teams/Get-CsTenantNetworkRegion.md index 0a45702fa8..4e5bac9aa2 100644 --- a/skype/skype-ps/skype/Get-CsTenantNetworkRegion.md +++ b/teams/teams-ps/teams/Get-CsTenantNetworkRegion.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantnetworkregion -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion +applicable: Microsoft Teams title: Get-CsTenantNetworkRegion schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,34 +19,33 @@ Returns information about the network region setting in the tenant. Tenant netwo ### Identity (Default) ``` -Get-CsTenantNetworkRegion [-Tenant ] [[-Identity] ] [-LocalStore] - [] +Get-CsTenantNetworkRegion [[-Identity] ] [] ``` ### Filter ``` -Get-CsTenantNetworkRegion [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTenantNetworkRegion [-Filter ] [] ``` ## DESCRIPTION -A network region interconnects various parts of a network across multiple geographic areas. +A network region interconnects various parts of a network across multiple geographic areas. A network region contains a collection of network sites. For example, if your organization has many sites located in India, then you may choose to designate "India" as a network region. -Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. +Location-Based Routing is a feature that allows PSTN toll bypass to be restricted for users based on policy and the user's geographic location at the time of an incoming or outgoing PSTN call. -Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in Microsoft 365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Get-CsTenantNetworkRegion ``` The command shown in Example 1 returns the list of network regions for the current tenant. -###-------------------------- Example 2 -------------------------- +### Example 2 ```powershell PS C:\> Get-CsTenantNetworkRegion -Identity RedmondRegion ``` @@ -74,7 +73,7 @@ Accept wildcard characters: False The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network region to be returned. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: @@ -85,39 +84,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network regions are being returned. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters ](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -126,6 +94,12 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) + +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) + +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) diff --git a/skype/skype-ps/skype/Get-CsTenantNetworkSite.md b/teams/teams-ps/teams/Get-CsTenantNetworkSite.md similarity index 55% rename from skype/skype-ps/skype/Get-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Get-CsTenantNetworkSite.md index 6d36742388..140fb2c326 100644 --- a/skype/skype-ps/skype/Get-CsTenantNetworkSite.md +++ b/teams/teams-ps/teams/Get-CsTenantNetworkSite.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantnetworksite -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite +applicable: Microsoft Teams title: Get-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,13 +19,17 @@ Returns information about the network site setting in the tenant. Tenant network ### Identity (Default) ``` -Get-CsTenantNetworkSite [-Tenant ] [[-Identity] ] [-LocalStore] - [] +Get-CsTenantNetworkSite [[-Identity] ] [-IncludePhoneNumbers ] [] +``` + +### QueryParameter +``` +Get-CsTenantNetworkSite [-IncludePhoneNumbers ] [-Filter ] [] ``` ### Filter ``` -Get-CsTenantNetworkSite [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTenantNetworkSite [-IncludePhoneNumbers ] [-Filter ] [] ``` ## DESCRIPTION @@ -33,7 +37,7 @@ A network site represents a location where your organization has a physical venu A best practice for Location Bsed Routing (LBR) is to create a separate site for each location which has unique PSTN connectivity. Each network site must be associated with a network region. Sites may be created as LBR or non-LBR enabled. A non-LBR enabled site may be created to allow LBR enabled users to make PSTN calls when they roam to that site. Note that network sites may also be used for emergency calling enablement and configuration. -Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. +Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. @@ -60,7 +64,7 @@ The command shown in Example 3 returns the network site that matches the specifi ## PARAMETERS ### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. +Enables you to use wildcard characters when indicating the site (or sites) to be returned. ```yaml Type: String @@ -75,28 +79,13 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network site to be returned. +The Identity parameter is a unique identifier for the site. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -104,12 +93,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network sites are being returned. +### -IncludePhoneNumbers +This parameter is reserved for internal Microsoft use. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: Boolean +Parameter Sets: All Aliases: Required: False @@ -118,10 +107,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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -129,7 +116,57 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS -### System.Object +### Identity +The Identity of the site. + +### Description +The description of the site. + +### NetworkRegionID +The network region ID of the site. + +### LocationPolicyID +The ID of the location policy assigned to the site. + +### SiteAddress +This parameter is reserved for internal Microsoft use. + +### NetworkSiteID +The ID of the network site. + +### OnlineVoiceRoutingPolicyTagID +The ID of the online voice routing policy assigned to the site. + +### EnableLocationBasedRouting +Boolean stating whether Location-Based Routing is enabled on the site. + +### EmergencyCallRoutingPolicyTagID +The ID of the Teams emergency call routing policy assigned to the site. + +### EmergencyCallingPolicyTagID +The ID of the Teams emergency calling policy assigned to the site. + +### NetworkRoamingPolicyTagID +The ID of the Teams network roaming policy assigned to the site. + +### EmergencyCallRoutingPolicyName +The name of the Teams emergency call routing policy assigned to the site. + +### EmergencyCallingPolicyName +The name of the Teams emergency calling policy assigned to the site. + +### NetworkRoamingPolicyName +The name of the Teams network roaming policy assigned to the site. + +### PhoneNumbers +This parameter is reserved for internal Microsoft use. + ## NOTES +The parameter IncludePhoneNumbers was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) + +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) + +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) diff --git a/skype/skype-ps/skype/Get-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md similarity index 69% rename from skype/skype-ps/skype/Get-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md index 5d1445e9a0..451655976b 100644 --- a/skype/skype-ps/skype/Get-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenantnetworksubnet -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet +applicable: Microsoft Teams title: Get-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,13 +19,12 @@ Returns information about the network subnet setting in the tenant. Tenant netwo ### Identity (Default) ``` -Get-CsTenantNetworkSubnet [-Tenant ] [[-Identity] ] [-LocalStore] - [] +Get-CsTenantNetworkSubnet [[-Identity] ] [] ``` ### Filter ``` -Get-CsTenantNetworkSubnet [-Tenant ] [-Filter ] [-LocalStore] [] +Get-CsTenantNetworkSubnet [-Filter ] [] ``` ## DESCRIPTION @@ -33,20 +32,20 @@ IP subnets at the location where Teams endpoints can connect to the network must Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. -Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. +Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Get-CsTenantNetworkSubnet ``` The command shown in Example 1 returns the list of network subnets for the current tenant. -###-------------------------- Example 2 -------------------------- +### Example 2 ```powershell PS C:\> Get-CsTenantNetworkSubnet -Identity '2001:4898:e8:25:844e:926f:85ad:dd70' ``` @@ -55,26 +54,11 @@ The command shown in Example 2 returns the IPv6 format network subnet within the ## PARAMETERS -### -Filter -The Filter parameter allows you to limit the number of results based on filters you specify. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity -The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnet to be returned. +The Identity parameter is a unique identifier that designates the scope. It specifies the collection of tenant network subnets to be returned. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: @@ -85,27 +69,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network subnets are being returned. +### -Filter +The Filter parameter allows you to limit the number of results based on filters you specify. ```yaml -Type: System.Guid -Parameter Sets: (All) +Type: String +Parameter Sets: Filter Aliases: Required: False @@ -116,8 +85,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -125,7 +93,12 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS -### System.Object ## NOTES ## RELATED LINKS + +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) + +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) + +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) diff --git a/skype/skype-ps/skype/Get-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md similarity index 93% rename from skype/skype-ps/skype/Get-CsTenantTrustedIPAddress.md rename to teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md index d861b51cb5..178e4bd1fa 100644 --- a/skype/skype-ps/skype/Get-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/teams/Get-CsTenantTrustedIPAddress.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-cstenanttrustedipaddress -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenanttrustedipaddress +applicable: Microsoft Teams title: Get-CsTenantTrustedIPAddress schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantTrustedIPAddress @@ -33,7 +33,7 @@ External trusted IPs are the Internet external IPs of the enterprise network and If the user's external IP matches one defined in the trusted list, then Location-Based Routing will check to determine which internal subnet the user's endpoint is located. If the user's external IP doesn't match one defined in the trusted list, the endpoint will be classified as being at an unknown and any PSTN calls to/from an LBR enabled user are blocked. -Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. +Location Based Routing is a feature which allows PSTN toll bypass to be restricted for users based upon policy and the user's geographic location at the time of an incoming or outgoing PSTN call. Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. It is now available in O365 for Teams clients. For toll bypass restricted locations, each IP subnet and PSTN gateway for that location are associated to a network site by the administrator. A user's location is determined by the IP subnet which the user's Teams endpoint(s) is connected to at the time of a PSTN call. A user may have multiple Teams clients located at different sites, in which case Location-Based Routing will enforce each client's routing separately depending on the location of its endpoint. @@ -116,8 +116,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -126,6 +125,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-CsUserCallingSettings.md b/teams/teams-ps/teams/Get-CsUserCallingSettings.md index 143158a185..43b422011c 100644 --- a/teams/teams-ps/teams/Get-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Get-CsUserCallingSettings.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csusercallingsettings +online version: https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Get-CsUserCallingSettings schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Get-CsUserCallingSettings @@ -108,13 +109,12 @@ CallGroupOwnerId NotificationSetting sip:user6@contoso.com Ring ``` -This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com +This example shows that user4@contoso.com has simultaneous ringing set to his/her call group (ForwardingTargetType) and that the call group contains user5@contoso.com (CallGroupTargets). The call group is defined to ring members in the order listed in the call group (CallGroupOrder). You can also see that user4@contoso.com is a member of user6@contoso.com's call group (GroupMembershipDetails), that user6@contoso.com defined the call group with Ring notification for user4@contoso.com (NotificationSetting) and that user4@contoso.com has decided to turn off call notification for call group calls (GroupNotificationOverride). - ### Example 4 ```powershell Get-CsUserCallingSettings -Identity user7@contoso.com @@ -130,7 +130,7 @@ UnansweredTarget : UnansweredTargetType : Voicemail UnansweredDelay : 00:00:20 Delegates : Id:sip:user8@contoso.com -Delegators : +Delegators : CallGroupOrder : InOrder CallGroupTargets : {} GroupMembershipDetails : @@ -189,20 +189,20 @@ Get-CsUserCallingSettings -Identity user11@contoso.com ``` ```output SipUri : sip:user11@contoso.com -IsForwardingEnabled : -ForwardingType : +IsForwardingEnabled : +ForwardingType : ForwardingTarget : -ForwardingTargetType : -IsUnansweredEnabled : +ForwardingTargetType : +IsUnansweredEnabled : UnansweredTarget : -UnansweredTargetType : +UnansweredTargetType : UnansweredDelay : 00:00:20 Delegates : -Delegators : +Delegators : CallGroupOrder : Simultaneous CallGroupTargets : {} GroupMembershipDetails : -GroupNotificationOverride : +GroupNotificationOverride : ``` This example shows the default settings for a user that has never changed the call forward settings via Microsoft Teams. Note that for users with settings as shown here, @@ -240,10 +240,10 @@ The cmdlet is available in Teams PowerShell module 4.0.0 or later. ## RELATED LINKS -[Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) +[Set-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings) -[New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) -[Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) -[Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md index 7a55e56e91..692be05e33 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-csuserpolicyassignment +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment +title: Get-CsUserPolicyAssignment schema: 2.0.0 author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserPolicyAssignment @@ -77,7 +78,6 @@ AssignmentType PolicyName Reference Group AllOn d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 Group Kiosk 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 - Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy GroupId PolicyType PolicyName Rank CreatedTime CreatedBy @@ -91,7 +91,7 @@ d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/20 ### -Identity The identify of the user whose policy assignments will be returned. -The -Identity parameter can be in the form of the users ObjectID (taken from Azure AD) or in the form of the UPN (a.smith@example.com) +The -Identity parameter can be in the form of the users ObjectID (taken from Microsoft Entra ID) or in the form of the UPN (a.smith@example.com) ```yaml Type: String @@ -226,10 +226,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -245,14 +243,14 @@ For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT \: Identity Parameter \[GroupId \\]: The ID of a group whose policy assignments will be returned. - \[Identity \\]: + \[Identity \\]: \[OperationId \\]: The ID of a batch policy assignment operation. \[PolicyType \\]: The policy type for which group policy assignments will be returned. - + ## RELATED LINKS -[New-CsGroupPolicyAssignment]() +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment]() +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment]() +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md b/teams/teams-ps/teams/Get-CsUserPolicyPackage.md index c95bd5833e..c0edaf3689 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyPackage.md @@ -5,7 +5,7 @@ title: Get-CsUserPolicyPackage author: serdarsoysal ms.author: serdars manager: amitar -online version: https://docs.microsoft.com/powershell/module/teams/get-csuserpolicypackage +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage schema: 2.0.0 --- @@ -24,7 +24,7 @@ Get-CsUserPolicyPackage [-Identity] [] ## DESCRIPTION This cmdlet supports retrieving the policy package that's assigned to a user. Provide the identity of a user to retrieve the definition of their assigned policy package. -For more information on policy packages, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. ## EXAMPLES @@ -64,8 +64,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](Get-CsPolicyPackage.md) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) -[Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) diff --git a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md b/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md index e1427f1375..ca19b2c0d9 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md @@ -5,7 +5,7 @@ title: Get-CsUserPolicyPackageRecommendation author: serdarsoysal ms.author: serdars manager: amitar -online version: https://docs.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation +online version: https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation schema: 2.0.0 --- @@ -24,7 +24,7 @@ Get-CsUserPolicyPackageRecommendation [-Identity] [] ## DESCRIPTION This cmdlet supports retrieving recommendations for which policy packages are best suited for a given user. This recommendation is based on tenant and user information such as license types. -For more information on policy packages, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. ## EXAMPLES @@ -64,8 +64,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](Get-CsPolicyPackage.md) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) -[Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) -[Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +[Grant-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage) diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md similarity index 89% rename from skype/skype-ps/skype/Get-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md index f5cce46755..2210e9d40f 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/Get-CsVideoInteropServiceProvider.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csvideointeropserviceprovider -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Get-CsVideoInteropServiceProvider schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsVideoInteropServiceProvider @@ -16,7 +16,6 @@ ms.reviewer: ## SYNOPSIS Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. The CsVideoInteropServiceProvider cmdlets allow you to designate provider/tenant specific information about the connection to the provider. - ## SYNTAX ### Identity (Default) @@ -105,14 +104,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md index bea7f949cc..445cec3c6a 100644 --- a/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md +++ b/teams/teams-ps/teams/Get-LicenseReportForChangeNotificationSubscription.md @@ -2,10 +2,10 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams title: Get-LicenseReportForChangeNotificationSubscription -author: anandab-msft -ms.author: anandab +author: serdarsoysal +ms.author: serdars manager: alagra -online version: https://docs.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription +online version: https://learn.microsoft.com/powershell/module/teams/get-licensereportforchangenotificationsubscription schema: 2.0.0 --- @@ -13,17 +13,17 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet tells whether a user has the required license to export their messages via [change notification subscription](/graph/teams-licenses). +This cmdlet tells whether a user has the required license to export their messages via [change notification subscription](https://learn.microsoft.com/graph/teams-licenses). ## SYNTAX ``` -Get-LicenseReportForChangeNotificationSubscription [-Period] +Get-LicenseReportForChangeNotificationSubscription [-Period] [] ``` ## DESCRIPTION -This cmdlet supports retrieving the total number of messages sent by a user in chat/channel and whether a user has the required license(s) to send change notification events when subscribed for chat or channel messages. For more details, please review [Licenses for subscribing to chat messages](/graph/teams-licenses). +This cmdlet supports retrieving the total number of messages sent by a user in chat/channel and whether a user has the required license(s) to send change notification events when subscribed for chat or channel messages. For more details, please review [Licenses for subscribing to chat messages](https://learn.microsoft.com/graph/teams-licenses). This cmdlet is currently supported in preview version only. ## EXAMPLES @@ -50,4 +50,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -## RELATED LINKS +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-M365TeamsApp.md b/teams/teams-ps/teams/Get-M365TeamsApp.md new file mode 100644 index 0000000000..2d665c2c79 --- /dev/null +++ b/teams/teams-ps/teams/Get-M365TeamsApp.md @@ -0,0 +1,128 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365TeamsApp +applicable: Microsoft Teams +title: Get-M365TeamsApp +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +schema: 2.0.0 +--- + +# Get-M365TeamsApp + +## SYNOPSIS + +This cmdlet returns app availability and state for the Microsoft Teams app. + +## SYNTAX + +```powershell +Get-M365TeamsApp -Id [] +``` + +## DESCRIPTION + +Get-M365TeamsApps retrieves information about the Teams app. This includes app state, app availability, user who updated app availability, and the associated timestamp. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-M365TeamsApp -Id b782e2e8-9682-4898-b211-a304714f4f6b +``` + +Provides information about b782e2e8-9682-4898-b211-a304714f4f6b app, which includes app state, app availability, user who updated app availability, and the associated timestamp. + +## PARAMETERS + +### -Id + +Application ID of the Teams app. + +```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 + +**ID** +Application ID of the Teams app. + +**IsBlocked** +The state of the app in the tenant. +Values: + +- Blocked +- Unblocked + +**AvailableTo** +Provides available to properties for the app. +Properties: + +- AssignmentType: App availability type. + Values: + - Everyone + - UsersandGroups + - Noone +- Users: List of all the users for whom the app is enabled. + Values: + - Id: GUID of UserIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. +- Groups: List of all the groups for whom the app is enabled. + Values: + - Id: GUID of GroupIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. + +**InstalledFor** +Provides installed for properties for the app. +Properties: + +- AppInstallType: App install type. + Values: + - Everyone + - UsersandGroups + - Noone +- LastUpdatedTimestamp: Last Updated date +- InstalledBy: The user performing the installation +- InstalledSource: Source of installation +- Version: Version of the app installed +- InstallForUsers: List of all the users for whom the app is enabled. + Values: + - Id: GUID of UserIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. +- InstallForGroups: List of all the groups for whom the app is enabled. + Values: + - Id: GUID of GroupIDs. + - AssignedBy: UserID of last user who updated the app AvailableTo value. + - LastUpdatedTimeStamp: Time and date when the app AvailableTo value was last updated. + +## NOTES + +## RELATED LINKS + +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Update-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md b/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md new file mode 100644 index 0000000000..0e4deaa2f7 --- /dev/null +++ b/teams/teams-ps/teams/Get-M365UnifiedCustomPendingApps.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedCustomPendingApps +applicable: Microsoft Teams +title: Get-M365UnifiedCustomPendingApps +author: michelle-paradis +ms.author: mparadis +manager: swmerchant +ms.date: 01/14/2025 +schema: 2.0.0 +--- + +# Get-M365UnifiedCustomPendingApps + +## SYNOPSIS + +This cmdlet returns all custom Microsoft Teams apps that are pending review from an IT Admin. + +## SYNTAX + +```powershell +Get-M365UnifiedCustomPendingApps [] +``` + +## DESCRIPTION + +Get-M365UnifiedCustomPendingApps retrieves a complete list of all custom Microsoft Teams apps that are pending review, and their review statuses. + +## EXAMPLES + +### Example + +```powershell +PS C:\> Get-M365UnifiedCustomPendingApps +``` + +Returns a complete list of all custom Microsoft Teams apps that are pending review, and their review statuses. + +## 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 + +**Id**: +Application ID of the Teams app. + +**ExternalId**: +External ID of the Teams app. + +**Iteration**: +The Staged App Definition Etag of the app. This is a unique tag created everytime the staged app is updated, to help track changes. + +**CreatedBy**: +The User ID of the user that created the app. + +**LastUpdateDateTime**: +The date and time the app was last updated. + +**ReviewStatus**: +The review status of the app. +Values: + +- PendingPublishing: A new custom app was requested that hasn't been published before. +- PendingUpdate: An existing custom app that was previously published and now has an update. + +**Metadata**: +The metadata of the app. diff --git a/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md b/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md new file mode 100644 index 0000000000..c67594e6ff --- /dev/null +++ b/teams/teams-ps/teams/Get-M365UnifiedTenantSettings.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Get-M365UnifiedTenantSettings +applicable: Microsoft Teams +title: Get-M365UnifiedTenantSettings +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 10/22/2024 +schema: 2.0.0 +--- + +# Get-M365UnifiedTenantSettings + +## SYNOPSIS + +This cmdlet returns the current tenant settings for a particular tenant + +## SYNTAX + +```powershell +Get-M365UnifiedTenantSettings -SettingNames [] +``` + +## DESCRIPTION + +Get-M365UnifiedTenantSettings retrieves the current tenant settings for a particular tenant. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-M365UnifiedTenantSettings +``` + +Returns all the current tenant settings for this tenant. + +### Example 2 + +```powershell +PS C:\> Get-M365UnifiedTenantSettings -SettingNames DefaultApp +``` + +Returns the current tenant setting for DefaultApp for this tenant. + +### Example 3 + +```powershell +PS C:\> Get-M365UnifiedTenantSettings -SettingNames DefaultApp,EnableCopilotExtensibility +``` + +Returns the current tenant setting for DefaultApp and EnableCopilotExtensibility for this tenant. + +## PARAMETERS + +### -SettingNames + +Setting names requested. Possible values - DefaultApp,GlobalApp,PrivateApp,EnableCopilotExtensibility + +```yaml +Type: String +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +**SettingName** +Setting Name returned. + +**SettingValue** +The status of this setting in the tenant. +Values: + +- All +- None +- Some (only applicable for EnableCopilotExtensibility) + +**Users** +The list of users this setting is applicable to (only applicable for EnableCopilotExtensibility). + +**Groups** +The list of groups this setting is applicable to (only applicable for EnableCopilotExtensibility). + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Get-SharedWithTeam.md b/teams/teams-ps/teams/Get-SharedWithTeam.md new file mode 100644 index 0000000000..4728ffa1b4 --- /dev/null +++ b/teams/teams-ps/teams/Get-SharedWithTeam.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteam +title: Get-SharedWithTeam +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-SharedWithTeam + +## SYNOPSIS +This cmdlet supports retrieving teams with which a specified channel is shared. + +## SYNTAX +```PowerShell +Get-SharedWithTeam -HostTeamId -ChannelId [-SharedWithTeamId ] [] +``` + +## DESCRIPTION +This cmdlet supports retrieving teams with which a specified channel is shared. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +``` + +Returns teams with which a specified channel is shared. + +### Example 2 +```PowerShell +Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b +``` + +Returns detail of a team with which a specified channel is shared. + +## PARAMETERS + +### -HostTeamId +Team ID of the host team (Group ID). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChannelId +Thread ID of the shared channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedWithTeamId +Team ID of the shared with team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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/?LinkID=113216). + +## INPUTS + +### HostTeamId, ChannelId, SharedWithTeamId + +## OUTPUTS + +### Team + +## NOTES + +## RELATED LINKS +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[Get-AssociatedTeam](https://learn.microsoft.com/powershell/module/teams/get-team) diff --git a/teams/teams-ps/teams/Get-SharedWithTeamUser.md b/teams/teams-ps/teams/Get-SharedWithTeamUser.md new file mode 100644 index 0000000000..4a3f016867 --- /dev/null +++ b/teams/teams-ps/teams/Get-SharedWithTeamUser.md @@ -0,0 +1,119 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-sharedwithteamuser +title: Get-SharedWithTeamUser +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-SharedWithTeamUser + +## SYNOPSIS +This cmdlet supports retrieving users of a shared with team. + +## SYNTAX +```PowerShell +Get-SharedWithTeamUser -HostTeamId -ChannelId -SharedWithTeamId [-Role ] [] +``` + +## DESCRIPTION +This cmdlet supports retrieving users of a shared with team. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-SharedWithTeamUser -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b +``` + +Returns users of a team with which a specified channel is shared. + +### Example 2 +```PowerShell +Get-AssociatedTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b -Role owner +``` + +Returns owners of a team with which a specified channel is shared. + +## PARAMETERS + +### -HostTeamId +Team ID of the host team (Group ID). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChannelId +Thread ID of the shared channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedWithTeamId +Team ID of the shared with team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Role +Filters the results to only users with the given role of "Owner" or "Member". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/?LinkID=113216). + +## INPUTS + +### HostTeamId, ChannelId, SharedWithTeamId + +## OUTPUTS + +### User + +## NOTES + +## RELATED LINKS +[Get-TeamUser](https://learn.microsoft.com/powershell/module/teams/get-teamuser) diff --git a/teams/teams-ps/teams/Get-Team.md b/teams/teams-ps/teams/Get-Team.md index 870eaf14c8..b2edb13e51 100644 --- a/teams/teams-ps/teams/Get-Team.md +++ b/teams/teams-ps/teams/Get-Team.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-team +online version: https://learn.microsoft.com/powershell/module/teams/get-team +title: Get-Team schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -126,7 +127,7 @@ Accept wildcard characters: False ``` ### -DisplayName -Filters to return teams with a full match to the provided displayname. As displayname is not unique, this acts as a filter rather than an exact match. Note that this filter value is case-sensitive. +Specify this parameter to return teams with the provided display name as a filter. As the display name is not unique, multiple values can be returned. Note that this filter value is case-sensitive. ```yaml Type: String @@ -237,8 +238,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -252,6 +252,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[New-Team](new-team.md) +[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) -[Set-Team](set-team.md) +[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) diff --git a/teams/teams-ps/teams/Get-TeamAllChannel.md b/teams/teams-ps/teams/Get-TeamAllChannel.md new file mode 100644 index 0000000000..eae8aeb08e --- /dev/null +++ b/teams/teams-ps/teams/Get-TeamAllChannel.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/get-teamallchannel +title: Get-TeamAllChannel +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Get-TeamAllChannel + +## SYNOPSIS +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +## SYNTAX +```PowerShell +Get-TeamAllChannel -GroupId [-MembershipType ] [] +``` + +## DESCRIPTION +This cmdlet supports retrieving all channels of a team, including incoming channels and channels hosted by the team. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 +``` + +Returns all channels of a team. + +### Example 2 +```PowerShell +Get-TeamAllChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -MembershipType Shared +``` + +Returns all shared channels of a team. + +## PARAMETERS + +### -GroupId +Returns the Group ID of the team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MembershipType +Membership type of the channel to display; Standard, Private, or Shared + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +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/?LinkID=113216). + +## INPUTS + +### GroupId, MembershipType + +## OUTPUTS + +### Channel + +## NOTES + +## RELATED LINKS +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamIncomingChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamChannel.md b/teams/teams-ps/teams/Get-TeamChannel.md index cd0a8207cd..9eae890d9e 100644 --- a/teams/teams-ps/teams/Get-TeamChannel.md +++ b/teams/teams-ps/teams/Get-TeamChannel.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-teamchannel +online version: https://learn.microsoft.com/powershell/module/teams/get-teamchannel +title: Get-TeamChannel schema: 2.0.0 --- -# Get-TeamChannel +# Get-TeamChannel ## SYNOPSIS - -Get all the channels for a team. +This cmdlet supports retrieving channels hosted by a team. ## SYNTAX - ``` Get-TeamChannel -GroupId [-MembershipType ] [] ``` ## DESCRIPTION +This cmdlet supports retrieving channels hosted by a team. ## EXAMPLES diff --git a/teams/teams-ps/teams/Get-TeamChannelUser.md b/teams/teams-ps/teams/Get-TeamChannelUser.md index 62dc14196e..a245c41c40 100644 --- a/teams/teams-ps/teams/Get-TeamChannelUser.md +++ b/teams/teams-ps/teams/Get-TeamChannelUser.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-teamchanneluser +online version: https://learn.microsoft.com/powershell/module/teams/get-teamchanneluser +title: Get-TeamChannelUser schema: 2.0.0 --- -# Get-TeamChannelUser +# Get-TeamChannelUser ## SYNOPSIS Returns users of a channel. @@ -18,7 +19,7 @@ Get-TeamChannelUser -GroupId -DisplayName [-Role ] [ [] +``` + +## DESCRIPTION +This cmdlet supports retrieving incoming channels of a team. + +## EXAMPLES + +### Example 1 +```PowerShell +Get-TeamIncomingChannel -GroupId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 +``` + +Returns incoming channels of a team. + +## PARAMETERS + +### -GroupId +Group ID of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +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/?LinkID=113216). + +## INPUTS + +### GroupId + +## OUTPUTS + +### Channel + +## NOTES + +## RELATED LINKS +[Get-TeamChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) +[Get-TeamAllChannel](https://learn.microsoft.com/powershell/module/teams/get-teamchannel) diff --git a/teams/teams-ps/teams/Get-TeamMemberSettings.md b/teams/teams-ps/teams/Get-TeamMemberSettings.md index c38c685cab..f2b4df4491 100644 --- a/teams/teams-ps/teams/Get-TeamMemberSettings.md +++ b/teams/teams-ps/teams/Get-TeamMemberSettings.md @@ -3,7 +3,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-TeamMemberSettings -online version: https://docs.microsoft.com/powershell/module/teams/get-teammembersettings +online version: https://learn.microsoft.com/powershell/module/teams/get-teammembersettings schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -57,4 +57,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamMessagingSettings.md b/teams/teams-ps/teams/Get-TeamMessagingSettings.md index 2f3dbdf6b9..75cbd47356 100644 --- a/teams/teams-ps/teams/Get-TeamMessagingSettings.md +++ b/teams/teams-ps/teams/Get-TeamMessagingSettings.md @@ -3,7 +3,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-TeamMessagingSettings -online version: https://docs.microsoft.com/powershell/module/teams/get-teammessagingsettings +online version: https://learn.microsoft.com/powershell/module/teams/get-teammessagingsettings schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -57,4 +57,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md b/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md index 2764032a63..2480953c1b 100644 --- a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md +++ b/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus +online version: https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus +title: Get-TeamTargetingHierarchyStatus schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -11,13 +12,13 @@ ms.reviewer: ## SYNOPSIS -Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://docs.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) +Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy)) ## SYNTAX ### Get (Default) ``` -Get-TeamTargetingHierarchyStatus [-RequestId ] +Get-TeamTargetingHierarchyStatus [-RequestId ] [-ApiVersion ] [] ``` ## EXAMPLES @@ -40,12 +41,12 @@ LastKnownStatus : Validating ErrorMessage : 1 error(s) were found. Error: InvalidTeamId Descriptions: - TeamID in row 2 doesn’t match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 3 doesn’t match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 4 doesn’t match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 5 doesn’t match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 6 doesn’t match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. - TeamID in row 7 doesn’t match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 2 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 3 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 4 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 5 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 6 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. + TeamID in row 7 doesn't match a valid Group ID. Please view our documentation to learn how to get the proper Group ID for each team. LastUpdatedAt : 2021-02-17T22:28:08.7832795+00:00 LastModifiedBy : a145d7eb-b70d-4591-9455-6c87382a22b7 @@ -80,10 +81,33 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: false +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES ## RELATED LINKS -[Set-TeamTargetingHierarchy](https://docs.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Get-TeamUser.md b/teams/teams-ps/teams/Get-TeamUser.md index 8cc726b6ed..a7b4fd3d69 100644 --- a/teams/teams-ps/teams/Get-TeamUser.md +++ b/teams/teams-ps/teams/Get-TeamUser.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-teamuser +online version: https://learn.microsoft.com/powershell/module/teams/get-teamuser +title: Get-TeamUser schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -30,7 +31,6 @@ Get-TeamUser -GroupId 2f162b0e-36d2-4e15-8ba3-ba229cecdccf -Role Owner ``` This example returns the UPN, UserId, Name, and Role of the owners of the specified GroupId. - ## PARAMETERS ### -GroupId @@ -64,8 +64,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Get-TeamsApp.md b/teams/teams-ps/teams/Get-TeamsApp.md index 0b5d754c10..e393faf0f5 100644 --- a/teams/teams-ps/teams/Get-TeamsApp.md +++ b/teams/teams-ps/teams/Get-TeamsApp.md @@ -6,7 +6,7 @@ author: joeyglocke ms.author: joglocke ms.reviewer: ken.withee manager: islubin -online version: https://docs.microsoft.com/powershell/module/teams/get-teamsapp +online version: https://learn.microsoft.com/powershell/module/teams/get-teamsapp schema: 2.0.0 --- @@ -75,7 +75,7 @@ Accept wildcard characters: False ``` ### -ExternalId -The external ID of the app, provided by the app developer and used by Azure Active Directory +The external ID of the app, provided by the app developer and used by Microsoft Entra ID ```yaml Type: String @@ -105,14 +105,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Get-TeamsAppInstallation.md b/teams/teams-ps/teams/Get-TeamsAppInstallation.md index cfe9430c54..39ef59a41c 100644 --- a/teams/teams-ps/teams/Get-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Get-TeamsAppInstallation.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/get-teamsappinstallation +online version: https://learn.microsoft.com/powershell/module/teams/get-teamsappinstallation +title: Get-TeamsAppInstallation schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -28,7 +29,7 @@ Get-TeamsAppInstallation -UserId [-AppInstallationId ] [-AppId ## DESCRIPTION Get a Teams App installed in Microsoft Teams. -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://docs.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://docs.microsoft.com/microsoftteams/teams-powershell-release-notes). +Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -111,6 +112,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md similarity index 57% rename from skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md rename to teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md index 9ca081704a..b321e2118c 100644 --- a/skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csapplicationaccesspolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy +applicable: Microsoft Teams title: Grant-CsApplicationAccessPolicy schema: 2.0.0 manager: zhengni @@ -18,12 +18,24 @@ Assigns a per-user application access policy to one or more users. After assigni ## SYNTAX -### Identity (Default) +### Identity ``` Grant-CsApplicationAccessPolicy [-Identity ] [-PolicyName ] [-Global] ``` +### GrantToTenant (Default) +``` +Grant-CsApplicationAccessPolicy [-Global] [-PassThru] [-PolicyName ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsApplicationAccessPolicy [-PassThru] [-PolicyName ] [-MsftInternalProcessingMode ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION This cmdlet assigns a per-user application access policy to one or more users. After assigning an application access policy to a user, the applications configured in the policy will be authorized to access online meetings on behalf of that user.**Note:** You can assign only 1 application access policy at a time to a particular user. Assigning a new application access policy to a user will override the existing application access policy if any. @@ -71,7 +83,7 @@ Indicates the user (object) ID of the user account to be assigned the per-user a ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -112,6 +124,102 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. Be aware that this parameter is tied to the cmdlet itself instead of to a property of the input object. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 ## OUTPUTS @@ -120,7 +228,7 @@ Accept wildcard characters: False ## RELATED LINKS -[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) -[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) -[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) diff --git a/skype/skype-ps/skype/Grant-CsCallingLineIdentity.md b/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md similarity index 77% rename from skype/skype-ps/skype/Grant-CsCallingLineIdentity.md rename to teams/teams-ps/teams/Grant-CsCallingLineIdentity.md index 0b33ada804..bac8b79e4c 100644 --- a/skype/skype-ps/skype/Grant-CsCallingLineIdentity.md +++ b/teams/teams-ps/teams/Grant-CsCallingLineIdentity.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cscallinglineidentity -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity +applicable: Microsoft Teams title: Grant-CsCallingLineIdentity schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -67,7 +67,7 @@ Sets the parameters of the Global policy instance to the values in the specified Type: SwitchParameter Parameter Sets: (GrantToTenant) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -83,7 +83,7 @@ Enables you to pass a user object through the pipeline that represents the user Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -98,8 +98,8 @@ The name (Identity) of the Caller ID policy to be assigned. To remove an existin ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -115,7 +115,7 @@ Specifies the group used for the group policy assignment. Type: String Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -131,7 +131,7 @@ The rank of the policy assignment, relative to other group policy assignments fo Type: Int32 Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -146,8 +146,8 @@ the user's ObjectId/Identity. ```yaml Type: String Parameter Sets: (Identity) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 0 @@ -157,13 +157,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -179,7 +179,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -189,7 +189,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -200,10 +200,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[Set-CsCallingLineIdentity](set-cscallinglineidentity.md) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) -[Get-CsCallingLineIdentity](get-cscallinglineidentity.md) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) -[Remove-CsCallingLineIdentity](remove-cscallinglineidentity.md) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) -[New-CsCallingLineIdentity](new-cscallinglineidentity.md) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) diff --git a/skype/skype-ps/skype/Grant-CsCloudMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md similarity index 80% rename from skype/skype-ps/skype/Grant-CsCloudMeetingPolicy.md rename to teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md index 6f0385ae32..e85a10218d 100644 --- a/skype/skype-ps/skype/Grant-CsCloudMeetingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsCloudMeetingPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cscloudmeetingpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-cscloudmeetingpolicy +applicable: Microsoft Teams title: Grant-CsCloudMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsCloudMeetingPolicy @@ -24,7 +24,7 @@ Grant-CsCloudMeetingPolicy [-PolicyName] [-Tenant ] [-DomainContr ## DESCRIPTION The Grant-CsCloudMeetingPolicy cmdlet enables or disables automatic scheduling of Skype Meetings features for a specified user. -The default is disbaled. +The default is disabled. To enable automatic scheduling for all users in a tenant, use the Set-CsCloudMeetingPolicy cmdlet. @@ -40,7 +40,6 @@ Grant-CsCloudMeetingPolicy -PolicyName AutoScheduleEnabled -Identity "JaneC" This example enables Skype Meetings automatic scheduling for a user. - ## PARAMETERS ### -Identity @@ -50,8 +49,8 @@ For example: `-Identity "SeattlePSTN".` ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -67,8 +66,8 @@ Can be either AutoScheduleEnabled or AutoScheduleDisabled. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -84,7 +83,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -100,8 +99,8 @@ Valid inputs for this parameter are either the fully qualified domain name (FQDN ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -116,8 +115,8 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -138,8 +137,8 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -156,7 +155,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -166,7 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -175,5 +174,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS - - diff --git a/skype/skype-ps/skype/Grant-CsDialoutPolicy.md b/teams/teams-ps/teams/Grant-CsDialoutPolicy.md similarity index 71% rename from skype/skype-ps/skype/Grant-CsDialoutPolicy.md rename to teams/teams-ps/teams/Grant-CsDialoutPolicy.md index bdd92f0967..73c1d5c787 100644 --- a/skype/skype-ps/skype/Grant-CsDialoutPolicy.md +++ b/teams/teams-ps/teams/Grant-CsDialoutPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csdialoutpolicy -applicable: Skype for Business Online, Microsoft Teams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csdialoutpolicy +applicable: Microsoft Teams title: Grant-CsDialoutPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -33,7 +33,8 @@ Grant-CsDialoutPolicy [-Group] [[-PolicyName] ] [-PassThru] [-R ``` ## DESCRIPTION -In Skype for Business Online and Microsoft Teams, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. +In Microsoft Teams, outbound calling restriction policies are used to restrict the type of audio conferencing and end user PSTN calls that can be made by users in your organization. The policies apply to all the different PSTN connectivity options for Microsoft Teams; Calling Plan, Direct Routing, and Operator Connect. + To get all the available policies in your organization run `Get-CsOnlineDialOutPolicy`. ## EXAMPLES @@ -61,18 +62,17 @@ This example assigns the per-user outbound calling restriction policy DialoutCPC ### Example 4 ``` -Grant-CsDialoutPolicy -Global -PolicyName "InternationalAndDomestic" +Grant-CsDialoutPolicy -Global -PolicyName "DialoutCPCandPSTNInternational" ``` -This example sets the tenant global policy instance to InternationalAndDomestic. +This example sets the tenant global policy instance to DialoutCPCandPSTNInternational. ### Example 5 ``` -Grant-CsDialoutPolicy -Group support@contoso.com -Rank 10 -PolicyName "InternationalAndDomestic" +Grant-CsDialoutPolicy -Group support@contoso.com -Rank 10 -PolicyName "DialoutCPCandPSTNInternational" ``` -This example assigns the policy instance "InternationalAndDomestic" to the members of the group support@contoso.com. - +This example assigns the policy instance "DialoutCPCandPSTNInternational" to the members of the group support@contoso.com. ## PARAMETERS @@ -81,9 +81,9 @@ This parameter sets the tenant global policy instance. This is the policy that a ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Parameter Sets: GrantToTenant +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -99,7 +99,7 @@ Specifies the group used for the group policy assignment. Type: String Parameter Sets: GrantToGroup Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Applicable: Microsoft Teams Required: True Position: 0 @@ -109,18 +109,18 @@ Accept wildcard characters: False ``` ### -Identity -Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. +Specifies the Identity of the user account to be to be modified. A user identity can be specified by using one of three formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's ObjectId/Identity. ```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams Required: False Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` @@ -130,8 +130,8 @@ Returns the results of the command. By default, this cmdlet does not generate an ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -141,15 +141,15 @@ Accept wildcard characters: False ``` ### -PolicyName -"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondPolicy has a PolicyName equal to RedmondPolicy. +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DialoutCPCZoneAPSTNDomestic has a PolicyName equal to DialoutCPCZoneAPSTNDomestic. To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: +Applicable: Microsoft Teams Required: False Position: 1 @@ -165,7 +165,7 @@ The rank of the policy assignment, relative to other group policy assignments fo Type: Int32 Parameter Sets: GrantToGroup Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Applicable: Microsoft Teams Required: False Position: Named @@ -182,7 +182,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online, Microsoft Teams +Applicable: Microsoft Teams Required: False Position: Named @@ -198,7 +198,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online, Microsoft Teams +Applicable: Microsoft Teams Required: False Position: Named @@ -220,5 +220,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. +The cmdlet is not supported for Teams resource accounts. + ## RELATED LINKS -[Get-CsOnlineDialOutPolicy](get-csonlinedialoutpolicy.md) +[Get-CsOnlineDialOutPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialoutpolicy) diff --git a/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..ffce2c43e2 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md @@ -0,0 +1,297 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy +applicable: Microsoft Teams +title: Grant-CsExternalAccessPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Grant-CsExternalAccessPolicy + +## SYNOPSIS + +Enables you to assign an external access policy to a user or a group of users. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; and, 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsExternalAccessPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsExternalAccessPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Group] [-Rank] [] +``` + +### GrantToTenant +```powershell +Grant-CsExternalAccessPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +When you install Microsoft Teams or Skype for Business Server, your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation will not automatically provide users with this capability. +Instead, you must enable federation, and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +4. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +When you install Skype for Business Server, a global external access policy is automatically created for you. +In addition to this global policy, you can use the New-CsExternalAccessPolicy cmdlet to create additional external access policies configured at either the site or the per-user scope. + +When a policy is created at the site scope, it is automatically assigned to the site in question; for example, an external access policy with the Identity site:Redmond will automatically be assigned to the Redmond site. +By contrast, policies created at the per-user scope are not automatically assigned to anyone. +Instead, these policies must be explicitly assigned to a user or a group of users. +Assigning per-user policies is the job of the Grant-CsExternalAccessPolicy cmdlet. + +Note that per-user policies always take precedent over site policies and the global policy. +For example, suppose you create a per-user policy that allows communication with federated users, and you assign that policy to Ken Myer. +As long as that policy is in force, Ken will be allowed to communicate with federated users even if this type of communication is not allowed by Ken's site policy or by the global policy. +That's because the settings in the per-user policy take precedence. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +```powershell +Grant-CsExternalAccessPolicy -Identity "Ken Myer" -PolicyName RedmondAccessPolicy +``` + +Example 1 assigns the external access policy RedmondAccessPolicy to the user with the Active Directory display name Ken Myer. + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy +``` + +The command shown in Example 2 assigns the external access policy RedmondAccessPolicy to all the users who work in the city of Redmond. +To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who work in Redmond; the filter value "l=Redmond" limits returned data to those users who work in the city of Redmond (the l in the filter, a lowercase L, represents the locality). +That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection. + +### -------------------------- EXAMPLE 3 -------------------------- +```powershell +Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy +``` + +In Example 3, all the users who have the job title "Sales Representative" are assigned the external access policy SalesAccessPolicy. +To perform this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the Sales Representatives; the filter value "Title=Sales Representative" restricts the returned collection to users who have the job title "Sales Representative". +This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection. + +### -------------------------- EXAMPLE 4 -------------------------- +```powershell +Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy +``` + +The command shown in Example 4 assigns the external access policy BasicAccessPolicy to all the users who have not been explicitly assigned a per-user policy. +(That is, users currently being governed by a site policy or by the global policy.) To do this, the Get-CsUser cmdlet and the Filter parameter are used to return the appropriate set of users; the filter value {ExternalAccessPolicy -eq $Null} limits the returned data to user accounts where the ExternalAccessPolicy property is equal to (-eq) a null value ($Null). +By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy. + +### -------------------------- EXAMPLE 5 -------------------------- +```powershell +Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy +``` + +Example 5 assigns the external access policy USAccessPolicy to all the users who have accounts in the US organizational unit (OU). +The command starts off by calling the Get-CsUser cmdlet and the OU parameter; the parameter value "ou=US,dc=litwareinc,dc=com" limits the returned data to user accounts found in the US OU. +The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection. + +### -------------------------- EXAMPLE 6 -------------------------- +```powershell +Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null +``` + +Example 6 unassigns any per-user external access policy previously assigned to any of the users enabled for Skype for Business Server. +To do this, the command calls the Get-CsUser cmdlet (without any additional parameters) in order to return a collection of all the users enabled for Skype for Business Server. +That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which uses the syntax "`-PolicyName $Null`" to remove any per-user external access policy previously assigned to these users. + +## PARAMETERS + +### -Identity +Identity of the user account the policy should be assigned to. +User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when specifying the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith." + +```yaml +Type: UserIdParameter +Parameter Sets: GrantToUser +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +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.Rtc.Management.AD.UserIdParameter +String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. + +Grant-CsExternalAccessPolicy accepts pipelined input of string values representing the Identity of a user account. +The cmdlet also accepts pipelined input of user objects. + +## OUTPUTS + +### Output types +By default, Grant-CsExternalAccessPolicy does not return a value or object. + +However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/skype/skype-ps/skype/Grant-CsExternalUserCommunicationPolicy.md b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md similarity index 72% rename from skype/skype-ps/skype/Grant-CsExternalUserCommunicationPolicy.md rename to teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md index e017266735..d587ae4503 100644 --- a/skype/skype-ps/skype/Grant-CsExternalUserCommunicationPolicy.md +++ b/teams/teams-ps/teams/Grant-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csexternalusercommunicationpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csexternalusercommunicationpolicy +applicable: Microsoft Teams title: Grant-CsExternalUserCommunicationPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsExternalUserCommunicationPolicy @@ -34,14 +34,13 @@ Provide the detailed description here. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### -------------------------- Example 1 -------------------------- ``` Insert example commands for example 1. ``` Insert descriptive text for example 1. - ## PARAMETERS ### -PolicyName @@ -50,8 +49,8 @@ PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -67,7 +66,7 @@ PARAMVALUE: SwitchParameter Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -82,8 +81,8 @@ PARAMVALUE: Fqdn ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -98,8 +97,8 @@ PARAMVALUE: UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -114,8 +113,8 @@ PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -130,8 +129,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -147,7 +146,7 @@ PARAMVALUE: SwitchParameter Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -157,7 +156,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -166,5 +165,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS - - diff --git a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md b/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md index 16f2af5a0b..a3f18f52c8 100644 --- a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md +++ b/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md @@ -5,7 +5,7 @@ title: Grant-CsGroupPolicyPackageAssignment author: serdarsoysal ms.author: serdars manager: dasosby -online version: https://docs.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment +online version: https://learn.microsoft.com/powershell/module/teams/grant-csgrouppolicypackageassignment schema: 2.0.0 --- @@ -18,19 +18,19 @@ This cmdlet assigns a policy package to a group in a tenant. ## SYNTAX ``` -Grant-CsGroupPolicyPackageAssignment -GroupId -PackageName [-PolicyRankings ] [] +Grant-CsGroupPolicyPackageAssignment -GroupId -PackageName [-PolicyRankings ] [] [-Confirm] [-WhatIf] ``` ## DESCRIPTION -This cmdlet assigns a policy package to a group in a tenant. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. For more information on policy packages, please review [Manage policy packages in Microsoft Teams](https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages). +This cmdlet assigns a policy package to a group in a tenant. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. For more information on policy packages, please review [Manage policy packages in Microsoft Teams](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). Policy rankings can be optionally specified for each policy type in the package to determine which policies will be assigned to the user in case they belong to two or more groups. If policy rankings for a policy type is not specified, one of two things can happen: - If the policy type was previously assigned to the group, the ranking for the policy type will not change. - If the policy type was not previously assigned to the group, the ranking for the policy type will be ranked last. -Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://docs.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). +Finally, if a user was directly assigned a package, direct assignment takes precedence over group assignment. For more information on policy rankings and group policy assignments, please review [the description section under New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment#description). ## EXAMPLES @@ -84,7 +84,7 @@ Accept wildcard characters: False ### -PolicyRankings -The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. +The policy rankings for each of the policy types in the package. To specify the policy rankings, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). Policy rank must be a number greater than or equal to 1. ```yaml Type: String[] @@ -98,6 +98,37 @@ 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 +``` + +### -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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -109,6 +140,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](https://docs.microsoft.com/powershell/module/teams/get-cspolicypackage) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) -[New-CsGroupPolicyAssignment](https://docs.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..d9f1d28be6 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,247 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlineaudioconferencingroutingpolicy +title: Grant-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Grant-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Online Audio Conferencing Routing policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsOnlineAudioConferencingRoutingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Applies the policy "test" to the user "". + +### Example 2 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -PolicyName Test -Identity Global +``` + +Applies the policy "test" to the entire tenant. + +### Example 3 + +```powershell +PS C:\> Grant-CsOnlineAudioConferencingRoutingPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Applies the policy "test" to the specified group. + +## 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 +``` + +### -Global + +This can be used to apply the policy to the entire tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md similarity index 83% rename from skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md index 285e8a3674..4f5598bbb8 100644 --- a/skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoiceroutingpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy +applicable: Microsoft Teams title: Grant-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,18 +18,18 @@ Assigns a per-user online voice routing policy to one user, a group of users, or ## SYNTAX ### Identity (Default) -``` -Grant-CsOnlineVoiceRoutingPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] +```powershell +Grant-CsOnlineVoiceRoutingPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [] ``` ### GrantToTenant -``` -Grant-CsOnlineVoiceRoutingPolicy [[-PolicyName] ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +```powershell +Grant-CsOnlineVoiceRoutingPolicy [[-PolicyName] ] [-PassThru] [-Global] [] ``` ### GrantToGroup -``` -Grant-CsOnlineVoiceRoutingPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] +```powershell +Grant-CsOnlineVoiceRoutingPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [] ``` ## DESCRIPTION @@ -168,37 +168,6 @@ 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 -``` - -### -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 -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -213,10 +182,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](new-csonlinevoiceroutingpolicy.md) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](get-csonlinevoiceroutingpolicy.md) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](set-csonlinevoiceroutingpolicy.md) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](remove-csonlinevoiceroutingpolicy.md) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md similarity index 72% rename from skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md index 2a5aec7312..fada417049 100644 --- a/skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoicemailpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy +applicable: Microsoft Teams title: Grant-CsOnlineVoicemailPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -16,6 +16,7 @@ ms.reviewer: Assigns an online voicemail policy to a user account, to a group of users, or set the tenant Global instance. Online voicemail policies manage usages for Voicemail service. ## SYNTAX + ### GrantToTenant (Default) ``` Grant-CsOnlineVoicemailPolicy [[-PolicyName] ] [-Global] [-PassThru] [-WhatIf] [-Confirm] [] @@ -57,8 +58,8 @@ Sets the parameters of the Global policy instance to the values in the specified ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -73,8 +74,8 @@ Enables you to pass a user object through the pipeline that represents the user ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -89,8 +90,8 @@ A unique identifier(name) of the policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -106,7 +107,7 @@ Specifies the group used for the group policy assignment. Type: String Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -122,7 +123,7 @@ The rank of the policy assignment, relative to other group policy assignments fo Type: Int32 Parameter Sets: GrantToGroup Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -137,8 +138,8 @@ The Identity parameter represents the ID of the specific user in your organizati ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -154,7 +155,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -170,7 +171,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -180,7 +181,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -191,10 +192,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..4b3575f42c --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsAIPolicy.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Grant-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Grant-CsTeamsAIPolicy + +## SYNOPSIS +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsAIPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsAIPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsAIPolicy [[-PolicyName] ] [-Group] -Rank + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsAIPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 +```powershell +PS C:\> Grant-CsTeamsAIPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) \ No newline at end of file diff --git a/skype/skype-ps/skype/Grant-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md similarity index 65% rename from skype/skype-ps/skype/Grant-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md index 4f2a4f6866..76d9afbba6 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md @@ -1,184 +1,224 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsapppermissionpolicy -applicable: Microsoft Teams, Skype for Business Online -title: Grant-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# Grant-CsTeamsAppPermissionPolicy - -## SYNOPSIS -**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: . - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsAppPermissionPolicy [[-Identity] ] [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsAppPermissionPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: . - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsAppPermissionPolicy -Identity "Ken Myer" -PolicyName StudentAppPermissionPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the StudentAppPermissionPolicy - -## 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 -``` - -### -DomainController -Do not use. -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Resets the values in the global policy to match those in the provided (PolicyName) policy. Note that this means all users with no explicit policy assigned will have these new policy settings. - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The user to whom the policy should be assigned. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Do not use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# Grant-CsTeamsAppPermissionPolicy + +## SYNOPSIS +**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . + +This is only applicable for tenants who have not been migrated to ACM or UAM. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsAppPermissionPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsAppPermissionPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsAppPermissionPolicy [[-PolicyName] ] [-Group] [-Rank] + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsAppPermissionPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +**NOTE**: You can use this cmdlet to assign a specific custom policy to a user. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: . + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsAppPermissionPolicy -Identity "Ken Myer" -PolicyName StudentAppPermissionPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the StudentAppPermissionPolicy + +## 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 +``` + +### -DomainController +Do not use. +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Resets the values in the global policy to match those in the provided (PolicyName) policy. Note that this means all users with no explicit policy assigned will have these new policy settings. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user to whom the policy should be assigned. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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 +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +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.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md similarity index 78% rename from skype/skype-ps/skype/Grant-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md index 496d653781..3568887beb 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsappsetuppolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsappsetuppolicy +applicable: Microsoft Teams title: Grant-CsTeamsAppSetupPolicy schema: 2.0.0 ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Grant-CsTeamsAppSetupPolicy @@ -17,20 +18,28 @@ author: tomkau As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## SYNTAX ### Identity (Default) ``` -Grant-CsTeamsAppSetupPolicy [[-Identity] ] [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsTeamsAppSetupPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsAppSetupPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsAppSetupPolicy [[-PolicyName] ] [-Group] [-Rank] [] ``` ### GrantToTenant ``` -Grant-CsTeamsAppSetupPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +Grant-CsTeamsAppSetupPolicy [[-PolicyName] ] [-Global] [-Force] [] ``` ## DESCRIPTION @@ -38,7 +47,7 @@ Grant-CsTeamsAppSetupPolicy [-PolicyName] [-Tenant ] [-Dom As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## EXAMPLES @@ -171,15 +180,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.AD.UserIdParameter - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Grant-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md similarity index 74% rename from skype/skype-ps/skype/Grant-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md index 8b663a5ffd..10b0d7085d 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/grant-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy +title: Grant-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -19,6 +20,13 @@ Grant-CsTeamsAudioConferencingPolicy [-Global] [-PassThru] [[-PolicyName] ] ``` +### GrantToGroup +``` +Grant-CsTeamsAudioConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] +``` + ### Identity ``` Grant-CsTeamsAudioConferencingPolicy [-PassThru] [[-PolicyName] ] [[-Identity] ] [-WhatIf] @@ -32,12 +40,10 @@ Granular control over which audio conferencing features your users can or cannot ### EXAMPLE 1 ``` -PS C:\> Grant-CsTeamsAudioCOnferencingPolicy -identity "Ken Myer" -PolicyName “Emea Users” +PS C:\> Grant-CsTeamsAudioCOnferencingPolicy -identity "Ken Myer" -PolicyName "Emea Users" ``` -In this example, a user with identity "Ken Myer" is being assigned the “Emea Users” policy. - - +In this example, a user with identity "Ken Myer" is being assigned the "Emea Users" policy. ## PARAMETERS @@ -102,6 +108,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -148,8 +184,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) -[Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) +[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md similarity index 91% rename from skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md index c206954ddd..6d1b8028b7 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md @@ -1,236 +1,235 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamscallholdpolicy -applicable: Microsoft Teams -title: Grant-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: -manager: abnair -ms.author: jomarque -author: joelhmarquez ---- - -# Grant-CsTeamsCallHoldPolicy - -## SYNOPSIS - -Assigns a per-user Teams call hold policy to one or more users. The Teams call hold policy is used to customize the call hold experience for Teams clients. - - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsCallHoldPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsCallHoldPolicy [[-PolicyName] ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsCallHoldPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams call hold policies are used to customize the call hold experience for teams clients. -When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. - -Assigning a teams call hold policy to a user sets an audio file to be played during the duration of the hold. - -## EXAMPLES - -### Example 1 -```powershell -Grant-CsTeamsCallHoldPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' -``` - -The command shown in Example 1 assigns the per-user Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". - -### Example 2 -```powershell -Grant-CsTeamsCallHoldPolicy -Identity 'Ken Myer' -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' -``` - -The command shown in Example 2 assigns the per-user Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the user with the display name "Ken Myer". - -### Example 3 -```powershell -Grant-CsTeamsCallHoldPolicy -Identity 'Ken Myer' -PolicyName $null -``` - -In Example 3, any per-user Teams call hold policy previously assigned to the user "Ken Myer" is revoked. -As a result, the user will be managed by the global Teams call hold policy. - -### Example 4 -```powershell -Grant-CsTeamsCallHoldPolicy -Global -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' -``` - -The command shown in Example 4 sets the Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, as the Global policy which will apply to all users in your tenant. - -### Example 5 -```powershell -Grant-CsTeamsCallHoldPolicy -Group sales@contoso.com -Rank 10 -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' -``` - -The command shown in Example 5 sets the Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the members of the group sales@contoso.com. - -## PARAMETERS - -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams call hold policy. -User Identities can be specified using one of the following formats: - -- The user's SIP address; -- The user's user principal name (UPN); -- The user's Active Directory display name (for example, Ken Myer). - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. - -By default, the Grant-CsTeamsCallHoldPoly cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. - -For example, a policy with the Identity Tag:ContosoPartnerCallHoldPolicy has a PolicyName equal to ContosoPartnerCallHoldPolicy. - -To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -### System.Object - -## NOTES - -The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. - -## RELATED LINKS - -[New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) - -[Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) - -[Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) - -[Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Grant-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Assigns a per-user Teams call hold policy to one or more users. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsCallHoldPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsCallHoldPolicy [[-PolicyName] ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsCallHoldPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsCallHoldPolicy -Identity 'KenMyer@contoso.com' -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 1 assigns the per-user Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". + +### Example 2 +```powershell +Grant-CsTeamsCallHoldPolicy -Identity 'Ken Myer' -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 2 assigns the per-user Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the user with the display name "Ken Myer". + +### Example 3 +```powershell +Grant-CsTeamsCallHoldPolicy -Identity 'Ken Myer' -PolicyName $null +``` + +In Example 3, any per-user Teams call hold policy previously assigned to the user "Ken Myer" is revoked. +As a result, the user will be managed by the global Teams call hold policy. + +### Example 4 +```powershell +Grant-CsTeamsCallHoldPolicy -Global -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 4 sets the Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, as the Global policy which will apply to all users in your tenant. + +### Example 5 +```powershell +Grant-CsTeamsCallHoldPolicy -Group sales@contoso.com -Rank 10 -PolicyName 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 5 sets the Teams call hold policy, ContosoPartnerTeamsCallHoldPolicy, to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams call hold policy. +User Identities can be specified using one of the following formats: + +- The user's SIP address; +- The user's user principal name (UPN); +- The user's Active Directory display name (for example, Ken Myer). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the Grant-CsTeamsCallHoldPoly cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +For example, a policy with the Identity Tag:ContosoPartnerCallHoldPolicy has a PolicyName equal to ContosoPartnerCallHoldPolicy. + +To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsTeamsCallParkPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md index 5b5be7a70b..65c8d7ab00 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsCallParkPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamscallparkpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallparkpolicy +applicable: Microsoft Teams title: Grant-CsTeamsCallParkPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -16,7 +16,7 @@ ms.reviewer: The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. -NOTE: the call park feature currently only available in desktop, web clients and mobile clients. Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly mode for users with the Phone Sytem license +NOTE: the call park feature currently only available in desktop, web clients and mobile clients. Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly mode for users with the Phone System license ## SYNTAX @@ -38,7 +38,6 @@ Grant-CsTeamsCallParkPolicy [-Group] [[-PolicyName] ] [-PassThr ## DESCRIPTION The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user. - ## EXAMPLES ### Example 1 @@ -90,7 +89,7 @@ Accept wildcard characters: False ### -PolicyName Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope ("tag:"). For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. -If you set PolicyName to a null value, the command will unassign any per-user policy assigned to the user. +If you set PolicyName to a null value, the command will unassign any per-user policy assigned to the user. ```yaml Type: String @@ -194,10 +193,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or later. ## RELATED LINKS -[Set-CsTeamsCallParkPolicy](set-csteamscallparkpolicy.md) +[Set-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy) -[Get-CsTeamsCallParkPolicy](get-csteamscallparkpolicy.md) +[Get-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallparkpolicy) -[New-CsTeamsCallParkPolicy](new-csteamscallparkpolicy.md) +[New-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy) -[Remove-CsTeamsCallParkPolicy](remove-csteamscallparkpolicy.md) +[Remove-CsTeamsCallParkPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md similarity index 77% rename from skype/skype-ps/skype/Grant-CsTeamsCallingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md index 015bc2c39c..c843a89e58 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamscallingpolicy +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy applicable: Microsoft Teams title: Grant-CsTeamsCallingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -20,18 +20,18 @@ Assigns a specific Teams Calling Policy to a user, a group of users, or sets the ## SYNTAX ### Identity (Default) -``` -Grant-CsTeamsCallingPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] +```powershell +Grant-CsTeamsCallingPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [] ``` ### GrantToTenant -``` -Grant-CsTeamsCallingPolicy [[-PolicyName] ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +```powershell +Grant-CsTeamsCallingPolicy [[-PolicyName] ] [-PassThru] [-Global] [] ``` ### GrantToGroup -``` -Grant-CsTeamsCallingPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] +```powershell +Grant-CsTeamsCallingPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [] ``` ## DESCRIPTION @@ -153,37 +153,6 @@ 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 -``` - -### -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 -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -199,10 +168,10 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or ## RELATED LINKS -[Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) -[Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) -[Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) -[New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md similarity index 77% rename from skype/skype-ps/skype/Grant-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md index f0f360b6ef..abfbdfe908 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamschannelspolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy +applicable: Microsoft Teams title: Grant-CsTeamsChannelsPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsTeamsChannelsPolicy @@ -30,6 +30,12 @@ Grant-CsTeamsChannelsPolicy [-PolicyName] [-Tenant ] [-Dom [-PassThru] [-Global] [-WhatIf] [-Confirm] [] ``` +### GrantToGroup +``` +Grant-CsTeamsChannelsPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION The CsTeamsChannelsPolicy allows you to manage features related to the Teams & Channels experience within the Teams application. The Grant-CsTeamsChannelsPolicy allows you to assign specific policies to users that have been created in your tenant. @@ -164,15 +170,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.AD.UserIdParameter - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Grant-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md similarity index 75% rename from skype/skype-ps/skype/Grant-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md index a1ac752815..caa013a167 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md @@ -1,240 +1,280 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy -applicable: Microsoft Teams, Skype for Business Online -title: Grant-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Grant-CsTeamsComplianceRecordingPolicy - -## SYNOPSIS -Assigns a per-user Teams recording policy to one or more users. -This policy is used to govern automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsComplianceRecordingPolicy [-Identity ] [-PolicyName ] - [-Tenant ] [-DomainController ] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsComplianceRecordingPolicy [-Global] [-PolicyName ] - [-Tenant ] [-DomainController ] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams recording policies are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. - -Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. -Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. -The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. -Existing calls and meetings are unaffected. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsComplianceRecordingPolicy -Identity 'Ken Myer' -PolicyName 'ContosoPartnerComplianceRecordingPolicy' -``` - -The command shown in Example 1 assigns the per-user Teams recording policy ContosoPartnerComplianceRecordingPolicy to the user with the display name "Ken Myer". - -### Example 2 -```powershell -PS C:\> Grant-CsTeamsComplianceRecordingPolicy -Identity 'Ken Myer' -PolicyName $null -``` - -In Example 2, any per-user Teams recording policy previously assigned to the user "Ken Myer" is revoked. -As a result, the user will be managed by the global Teams recording policy. - -## PARAMETERS - -### -Identity -Indicates the Identity of the user account to be assigned the per-user Teams recording policy. -User Identities can be specified using one of the following formats: -1) the user's SIP address; -2) the user's user principal name (UPN); -3) the user's Active Directory display name (for example, Ken Myer). - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. -To skip a warning when you do this operation, specify "-Global". - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Name of the policy to be assigned. -The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. -For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. - -To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. -By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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 - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Grant-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Assigns a per-user Teams recording policy to one or more users. +This policy is used to govern automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsComplianceRecordingPolicy [-Identity ] [-PolicyName ] + [-Tenant ] [-DomainController ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsComplianceRecordingPolicy [-Global] [-PolicyName ] + [-Tenant ] [-DomainController ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsComplianceRecordingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsComplianceRecordingPolicy -Identity 'Ken Myer' -PolicyName 'ContosoPartnerComplianceRecordingPolicy' +``` + +The command shown in Example 1 assigns the per-user Teams recording policy ContosoPartnerComplianceRecordingPolicy to the user with the display name "Ken Myer". + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsComplianceRecordingPolicy -Identity 'Ken Myer' -PolicyName $null +``` + +In Example 2, any per-user Teams recording policy previously assigned to the user "Ken Myer" is revoked. +As a result, the user will be managed by the global Teams recording policy. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams recording policy. +User Identities can be specified using one of the following formats: + +- The user's SIP address; +- The user's user principal name (UPN); +- The user's Active Directory display name (for example, Ken Myer). + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. +To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. +The PolicyName is simply the policy Identity without the policy scope i.e. the "Tag:" prefix. +For example, a policy with the Identity Tag:ContosoPartnerComplianceRecordingPolicy has a PolicyName equal to ContosoPartnerComplianceRecordingPolicy. + +To revoke a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Microsoft Teams or Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams recording policy. +By default, the Grant-CsTeamsComplianceRecordingPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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 + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md similarity index 83% rename from skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md index 9cc651781f..ef2205b07d 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md @@ -1,185 +1,222 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscortanapolicy -applicable: Microsoft Teams, Skype for Business Online -title: Grant-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta -author: akshbhat -ms.author: akshbhat -ms.reviewer: ---- - -# Grant-CsTeamsCortanaPolicy - -## SYNOPSIS -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsCortanaPolicy [[-Identity] ] [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsCortanaPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - -* Disabled - Cortana voice assistant is disabled -* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation -* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported - -This cmdlet lets you assign a Teams Cortana policy at the per-user scope. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsCortanaPolicy -identity "Ken Myer" -PolicyName MyCortanaPolicy -``` - -In this example, a user with identity "Ken Myer" is being assigned the MyCortanaPolicy - -## 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 -``` - -### -DomainController - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global - -```yaml -Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -You can return your tenant ID by running this command: -Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Grant-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Grant-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsCortanaPolicy [[-Identity] ] [-PolicyName] [-Tenant ] + [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsCortanaPolicy [-PolicyName] [-Tenant ] [-DomainController ] + [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsCortanaPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +This cmdlet lets you assign a Teams Cortana policy at the per-user scope. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsCortanaPolicy -identity "Ken Myer" -PolicyName MyCortanaPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the MyCortanaPolicy + +## 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 +``` + +### -DomainController + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +You can return your tenant ID by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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 + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md similarity index 78% rename from skype/skype-ps/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md index 9b5dfdd8e7..c86a84aa89 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,194 +1,199 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsemergencycallroutingpolicy -applicable: Microsoft Teams -title: Grant-CsTeamsEmergencyCallRoutingPolicy -author: jenstrier -ms.author: jenstr -manager: roykuntz -ms.reviewer: chenc -schema: 2.0.0 ---- - -# Grant-CsTeamsEmergencyCallRoutingPolicy - -## SYNOPSIS -This cmdlet assigns a Teams Emergency Call Routing policy. - -## SYNTAX - -### GrantToTenant (Default) -``` -Grant-CsTeamsEmergencyCallRoutingPolicy [[-PolicyName] ] [-Global] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEmergencyCallRoutingPolicy [-Group] [[-PolicyName] ] - [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -### Identity -``` -Grant-CsTeamsEmergencyCallRoutingPolicy [[-Identity] ] [[-PolicyName] ] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet assigns a Teams Emergency Call Routing policy to a user, a group of users, or to the Global policy instance. Teams Emergency Call Routing policy is used for the life cycle of emergency call routing - emergency numbers and routing configuration. - - -## EXAMPLES - -### Example 1 -```powershell -PS C:> Grant-CsTeamsEmergencyCallRoutingPolicy -Identity user1 -PolicyName TestECRP -``` - -This example assigns a Teams Emergency Call Routing policy(TestECRP) to a user(user1) - -## PARAMETERS - -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. - -```yaml -Type: SwitchParameter -Parameter Sets: (GrantToTenant) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the user account the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (Identity) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The Identity of the Teams Emergency Call Routing policy to apply. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-preview or later. - -## RELATED LINKS - -[New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) - -[Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) - -[Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) - -[Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsEmergencyCallRoutingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Grant-CsTeamsEmergencyCallRoutingPolicy + +## SYNOPSIS +This cmdlet assigns a Teams Emergency Call Routing policy. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsTeamsEmergencyCallRoutingPolicy [[-PolicyName] ] [-Global] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEmergencyCallRoutingPolicy [-Group] [[-PolicyName] ] + [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +### Identity +``` +Grant-CsTeamsEmergencyCallRoutingPolicy [[-Identity] ] [[-PolicyName] ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet assigns a Teams Emergency Call Routing policy to a user, a group of users, or to the Global policy instance. Teams Emergency Call Routing policy is used for the life cycle of emergency call routing - emergency numbers and routing configuration. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsEmergencyCallRoutingPolicy -Identity user1 -PolicyName Test +``` + +This example assigns a Teams Emergency Call Routing policy (Test) to a user (user1). + +### Example 2 +```powershell +Grant-CsTeamsEmergencyCallRoutingPolicy -Group sales@contoso.com -Rank 10 -PolicyName Test +``` + +This example assigns the Teams Emergency Call Routing policy (Test) to the members of the group sales@contoso.com. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: SwitchParameter +Parameter Sets: (GrantToTenant) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The Identity of the Teams Emergency Call Routing policy to apply. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) + +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) + +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md similarity index 84% rename from skype/skype-ps/skype/Grant-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md index 929f31c582..6a5ce3b2a9 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallingPolicy.md @@ -1,199 +1,198 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsemergencycallingpolicy -applicable: Microsoft Teams -title: Grant-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr -manager: roykuntz -ms.reviewer: chenc, pthota -schema: 2.0.0 ---- - -# Grant-CsTeamsEmergencyCallingPolicy - -## SYNOPSIS -This cmdlet assigns a Teams Emergency Calling policy. - -## SYNTAX - -### GrantToTenant (Default) -``` -Grant-CsTeamsEmergencyCallingPolicy [[-PolicyName] ] [-Global] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### Identity -``` -Grant-CsTeamsCallingPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToGroup -``` -Grant-CsTeamsEmergencyCallingPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet assigns a Teams Emergency Calling policy to a user, a group of users, or to the Global policy instance. Emergency Calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. - - -## EXAMPLES - -### Example 1 -```powershell -Grant-CsTeamsEmergencyCallingPolicy -Identity user1 -PolicyName TestTECP -``` - -This example assigns the Teams Emergency Calling policy TestTECP to a user - -### Example 2 -```powershell -Grant-CsTeamsEmergencyCallingPolicy -Global -PolicyName SalesTECP -``` - -Assigns the Teams Emergency Calling policy called "SalesTECP" to the Global policy instance. This sets the parameters in the Global policy instance to the values found in the SalesTECP instance. - -## PARAMETERS - -### -Global -Sets the parameters of the Global policy instance to the values in the specified policy instance. - -```yaml -Type: SwitchParameter -Parameter Sets: (GrantToTenant) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the Identity of the user account the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (Identity) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The Identity of the Teams Emergency Calling policy to apply to the user. To remove an existing user level policy assignment, specify PolicyName as $null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. - -```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -### System.Object - -## NOTES - -The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-preview or later. - -## RELATED LINKS - -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) - -[Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) - -[Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) - -[Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsEmergencyCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc, pthota +schema: 2.0.0 +--- + +# Grant-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS +This cmdlet assigns a Teams Emergency Calling policy. + +## SYNTAX + +### GrantToTenant (Default) +``` +Grant-CsTeamsEmergencyCallingPolicy [[-PolicyName] ] [-Global] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### Identity +``` +Grant-CsTeamsCallingPolicy [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEmergencyCallingPolicy [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet assigns a Teams Emergency Calling policy to a user, a group of users, or to the Global policy instance. Emergency Calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Example 1 +```powershell +Grant-CsTeamsEmergencyCallingPolicy -Identity user1 -PolicyName TestTECP +``` + +This example assigns the Teams Emergency Calling policy TestTECP to a user + +### Example 2 +```powershell +Grant-CsTeamsEmergencyCallingPolicy -Global -PolicyName SalesTECP +``` + +Assigns the Teams Emergency Calling policy called "SalesTECP" to the Global policy instance. This sets the parameters in the Global policy instance to the values found in the SalesTECP instance. + +## PARAMETERS + +### -Global +Sets the parameters of the Global policy instance to the values in the specified policy instance. + +```yaml +Type: SwitchParameter +Parameter Sets: (GrantToTenant) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The Identity of the Teams Emergency Calling policy to apply to the user. To remove an existing user level policy assignment, specify PolicyName as $null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### System.Object + +## NOTES + +The GrantToGroup syntax is supported in Teams PowerShell Module version 4.5.1-preview or later. + +## RELATED LINKS + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md index f4d7ffb6e8..58b0be1886 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy title: Grant-CsTeamsEnhancedEncryptionPolicy -author: xinawang -ms.author: xinawang +author: serdarsoysal +ms.author: serdars manager: mdress schema: 2.0.0 --- @@ -16,9 +16,20 @@ Cmdlet to assign a specific Teams enhanced encryption Policy to a user. ## SYNTAX +### Identity (Default) ``` -Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [[-Identity] ] [-Global] - [-WhatIf] [-Confirm] [] +Grant-CsTeamsEnhancedEncryptionPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ][-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEnhancedEncryptionPolicy [-PassThru] [[-PolicyName] ] -Group [-Rank ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -35,7 +46,6 @@ PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'KenMyer@contoso.com' -P The command shown in Example 1 assigns the per-user Teams enhanced encryption policy, ContosoPartnerTeamsEnhancedEncryptionPolicy, to the user with the user principal name (UPN) "KenMyer@contoso.com". - ### EXAMPLE 2 ```PowerShell PS C:\> Grant-CsTeamsEnhancedEncryptionPolicy -Identity 'Ken Myer' -PolicyName $null @@ -45,7 +55,6 @@ In Example 2, any per-user Teams enhanced encryption policy previously assigned As a result, the user will be managed by the global Teams enhanced encryption policy. - ## PARAMETERS ### -PassThru @@ -81,10 +90,9 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams enhanced encryption policy. - ```yaml Type: XdsIdentity -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -99,7 +107,7 @@ Use this switch if you want to grant the specified policy to be the default poli ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -109,6 +117,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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. @@ -143,24 +181,21 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Object ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) - -[New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) - -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) - -[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..ad83d722d4 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md @@ -0,0 +1,207 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamseventspolicy +title: Grant-CsTeamsEventsPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsEventsPolicy + +## SYNOPSIS +Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsEventsPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Assigns Teams Events policy to a user, group of users, or the entire tenant. + +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisablePublicWebinars +``` + +The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "user1@contoso.com". + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy $null +``` + +The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "user1@contoso.com". As a result, the user will be managed by the global Teams Events policy. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy DisablePublicWebinars +``` + +The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". + +## 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 +``` + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md similarity index 66% rename from skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md index a751b2cd85..cacbfb5a0b 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsfeedbackpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfeedbackpolicy +applicable: Microsoft Teams title: Grant-CsTeamsFeedbackPolicy schema: 2.0.0 manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau ms.reviewer: --- @@ -18,9 +18,22 @@ Use this cmdlet to grant a specific Teams Feedback policy to a user (the ability ## SYNTAX +### Identity (Default) +``` +Grant-CsTeamsFeedbackPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant ``` -Grant-CsTeamsFeedbackPolicy [-PassThru] [-Confirm] [[-PolicyName] ] [[-Identity] ] [-Global] - [-Tenant ] [-DomainController ] [-WhatIf] +Grant-CsTeamsFeedbackPolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsFeedbackPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -72,7 +85,7 @@ Use this parameter to make the specified policy in -PolicyName the new effective ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -83,11 +96,11 @@ Accept wildcard characters: False ``` ### -Identity -Indicates the identity of the user account the policy should be assigned to. +Indicates the identity of the user account the policy should be assigned to. ```yaml Type: Object -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -158,6 +171,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### Microsoft.Rtc.Management.AD.UserIdParameter @@ -165,6 +211,7 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..3f44d72269 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsFilesPolicy.md @@ -0,0 +1,207 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy +title: Grant-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsFilesPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams AI policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsFilesPolicy [] +``` + +### GrantToUser + +```powershell +Grant-CsTeamsFilesPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Group] -Rank [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsFilesPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +The Teams Files Policy is used to modify files related settings in Microsoft teams. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +PS C:\> Grant-CsTeamsFilesPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) + +[Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) + +[Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) + +[Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) + +[New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) diff --git a/skype/skype-ps/skype/Grant-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md similarity index 67% rename from skype/skype-ps/skype/Grant-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md index 9efe4e791c..4e0833c5a5 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md @@ -1,176 +1,220 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsipphonepolicy -applicable: Skype for Business Online -title: Grant-CsTeamsIPPhonePolicy -author: tonywoodruff -ms.author: anwoodru -ms.reviewer: kponnus -manager: sandrao -schema: 2.0.0 ---- - -# Grant-CsTeamsIPPhonePolicy - -## SYNOPSIS - -Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a user account or group of user accounts. Teams phone policies determine the features that are available to users of Teams phones. For example, you might enable the hot desking feature for some users while disabling it for others. - - -## SYNTAX - -``` -Grant-CsTeamsIPPhonePolicy [-PassThru] [-Confirm] [[-PolicyName] ] [[-Identity] ] [-Global] - [-Tenant ] [-DomainController ] [-WhatIf] -``` - -## DESCRIPTION -Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a phone signed in with an account that may be used by end users, common area phones, or meeting room accounts. - -Note: Assigning a per user policy will override any global policy taking effect against the respective user account. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsIPPhonePolicy -Identity Foyer1@contoso.com -PolicyName CommonAreaPhone -``` - -This example shows assignment of the CommonAreaPhone policy to user account Foyer1@contoso.com. - - -## 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 -``` - -### -DomainController -Microsoft Internal Use Only. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Use this parameter to make the specified policy in -PolicyName the new effective global policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Indicates the identity of the user account the policy should be assigned to. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -The Identity of the Teams phone policy to apply to the user. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Microsoft internal usage only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### Microsoft.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsipphonepolicy +applicable: Microsoft Teams +title: Grant-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Grant-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a user account or group of user accounts. Teams phone policies determine the features that are available to users of Teams phones. For example, you might enable the hot desking feature for some users while disabling it for others. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsIPPhonePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsIPPhonePolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsIPPhonePolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use the Grant-CsTeamsIPPhonePolicy cmdlet to assign a set of Teams phone policies to a phone signed in with an account that may be used by end users, common area phones, or meeting room accounts. + +Note: Assigning a per user policy will override any global policy taking effect against the respective user account. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsIPPhonePolicy -Identity Foyer1@contoso.com -PolicyName CommonAreaPhone +``` + +This example shows assignment of the CommonAreaPhone policy to user account Foyer1@contoso.com. + +## 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 +``` + +### -DomainController +Microsoft Internal Use Only. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. + +```yaml +Type: Object +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The Identity of the Teams phone policy to apply to the user. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Microsoft internal usage only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..126e7adfd2 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,191 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Grant-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Grant-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMediaConnectivityPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsMediaConnectivityPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] ] [-Group] -Rank + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsMediaConnectivityPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the Teams media connectivity policy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 +```powershell +PS C:\> Grant-CsTeamsMediaConnectivityPolicy -Global -PolicyName Test +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md index 15ae572918..960fd62910 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy +applicable: Microsoft Teams title: Grant-CsTeamsMediaLoggingPolicy author: LeoKuhorev ms.author: leokukharau -manager: saurk +manager: shalages schema: 2.0.0 --- @@ -14,34 +14,31 @@ schema: 2.0.0 ## SYNOPSIS -Assigns Teams Media Logging policy to a user, group of users or the entire tenant. +Assigns Teams Media Logging policy to a user or entire tenant. ## SYNTAX ### Identity (Default) - ``` Grant-CsTeamsMediaLoggingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] - [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] + [-WhatIf] [-Confirm] [] ``` ### GrantToTenant - ``` -Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] +Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] ``` ### GrantToGroup - ``` -Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] - [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Assigns Teams Media Logging policy to a user, group of users or the entire tenant. +Assigns Teams Media Logging policy to a user or entire tenant. TeamsMediaLoggingPolicy allows administrators to enable media logging for users. When assigned, it will enable media logging for the user overriding other settings. After unassigning the policy, media logging setting will revert to the previous value. ## EXAMPLES @@ -52,7 +49,7 @@ TeamsMediaLoggingPolicy allows administrators to enable media logging for users. PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName Enabled ``` -Assign Teams Media Logging policy to the user with the user principal name (UPN) "KenMyer@contoso.com". +Assign Teams Media Logging policy to a single user with the user principal name (UPN) "KenMyer@contoso.com". This will enable media logging for the user. ### EXAMPLE 2 @@ -60,7 +57,7 @@ Assign Teams Media Logging policy to the user with the user principal name (UPN) PS C:\> Grant-CsTeamsMediaLoggingPolicy -Identity 'KenMyer@contoso.com' -PolicyName $null ``` -Unassign Teams Media Logging policy from the user with the user principal name (UPN) "KenMyer@contoso.com". +Unassign Teams Media Logging policy from a single user with the user principal name (UPN) "KenMyer@contoso.com". This will revert media logging setting to the previous value. ### EXAMPLE 3 @@ -68,7 +65,7 @@ Unassign Teams Media Logging policy from the user with the user principal name ( PS C:\> Grant-CsTeamsMediaLoggingPolicy -Global -PolicyName Enabled ``` -Assign Teams Media Logging policy to the entire tenant. +Assign Teams Media Logging policy to the entire tenant. Note that this will enable logging for every single user in the tenant without a possibility to disable it for individual users. ### EXAMPLE 4 @@ -97,7 +94,7 @@ Use the "Global" Identity if you wish to set the policy for the entire tenant. Type: String Parameter Sets: Identity Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 1 @@ -114,7 +111,7 @@ Enables passing a user object through the pipeline that represents the user bein Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -135,7 +132,7 @@ If you set PolicyName to a null value, the command will unassign any individual Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 2 @@ -144,23 +141,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MsftInternalProcessingMode - -Internal Microsoft use only. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Global When this cmdlet is used with `-Global` identity, the policy applies to all users in the tenant, except any that have an explicit policy assignment. For example, if the user already has Media Logging policy set to "Enabled", and tenant admin assigns "$null" globally, the user will still have Media Logging policy "Enabled". @@ -169,7 +149,7 @@ When this cmdlet is used with `-Global` identity, the policy applies to all user Type: SwitchParameter Parameter Sets: GrantToTenant Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -187,7 +167,37 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: Required: False Position: Named @@ -204,7 +214,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -229,4 +239,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsMediaLoggingPolicy](/powershell/module/teams/get-csteamsmedialoggingpolicy) +[Get-CsTeamsMediaLoggingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..cd29d655c1 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Grant-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# Grant-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +Assigns a teams meeting branding policy at the per-user scope. The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +### GrantToUser +``` +Grant-CsTeamsMeetingBrandingPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] ] [-Group] -Rank + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsMeetingBrandingPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +Assigns a teams meeting branding policy at the per-user scope. The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## EXAMPLES + +### Assign TeamsMeetingBrandingPolicy to a user +```powershell +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -identity "alice@contoso.com" -PolicyName "Policy Test" +``` + +In this example, the command assigns TeamsMeetingBrandingPolicy with the name `Policy Test` to user `alice@contoso.com`. + +### Assign TeamsMeetingBrandingPolicy to a group +```powershell +PS C:\> Grant-CsTeamsMeetingBrandingPolicy -Group group@contoso.com -PolicyName "Policy Test" -Rank 1 +``` + +In this example, the command will assign TeamsMeetingBrandingPolicy with the name `Policy Test` to group `group@contoso.com`. + +## PARAMETERS + +### -Global +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user you want to grant policy to. This can be specified as an SIP address, UserPrincipalName, or ObjectId. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign it to `$Null`. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```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 + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md similarity index 72% rename from skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md index bf78e1122e..1fac390b29 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md @@ -1,16 +1,15 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsmeetingbroadcastpolicy -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: Grant-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- - # Grant-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS @@ -22,14 +21,20 @@ Grant-CsTeamsMeetingBroadcastPolicy \[-PolicyName\] \ \[-Tenant \] [-PolicyName] - [-Tenant ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsTeamsMeetingBroadcastPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] ``` ### GrantToTenant ``` -Grant-CsTeamsMeetingBroadcastPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingBroadcastPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,7 +42,6 @@ User-level policy for tenant admin to configure meeting broadcast behavior for t ## EXAMPLES - ## PARAMETERS ### -Confirm @@ -56,7 +60,7 @@ Accept wildcard characters: False ``` ### -DomainController -Not applicable to online service. +Not applicable to online service. ```yaml Type: Fqdn @@ -74,7 +78,7 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: GrantToTenant Aliases: Required: False @@ -89,7 +93,7 @@ Indicates the Identity of the user account the policy should be assigned to. Use ```yaml Type: UserIdParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -128,6 +132,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml @@ -159,8 +193,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -168,6 +201,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md similarity index 63% rename from skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md index f449b2c89b..555e7a9518 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsmeetingpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingpolicy +applicable: Microsoft Teams title: Grant-CsTeamsMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsTeamsMeetingPolicy @@ -15,12 +15,23 @@ ms.reviewer: ## SYNOPSIS Assigns a teams meeting policy at the per-user scope. The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users - ## SYNTAX +### GrantToTenant (Default) +```powershell +Grant-CsTeamsMeetingPolicy [-Global] [-PassThru] [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] ] + [[-Group] ] [-Rank ] [] ``` -Grant-CsTeamsMeetingPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-Identity] [-PassThru] [-WhatIf] [-Confirm] [] + +### Identity +```powershell +Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] ] + [[-Identity] ] [] ``` ## DESCRIPTION @@ -37,29 +48,13 @@ In this example, a user with identity "Ken Myer" is being assigned the StudentMe ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -DomainController ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -74,8 +69,8 @@ Indicates the Identity of the user account the policy should be assigned to. Use ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 0 @@ -89,8 +84,8 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -105,8 +100,8 @@ The name of the custom policy that is being assigned to the user. To remove a s ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -115,13 +110,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". ```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: Required: False Position: Named @@ -130,15 +125,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +```yaml +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -148,7 +171,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -161,4 +184,3 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..591125a048 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Grant-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [[-PolicyName] ] [-Group] [-Rank] + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsMeetingTemplatePermissionPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the TeamsMeetingTemplatePermissionPolicy to users or groups in a tenant. + +Pass in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 - Assign a policy to a user + +```powershell +PS> Grant-CsTeamsMeetingTemplatePermissionPolicy -PolicyName Foobar -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +## PARAMETERS + +### -PolicyName + +Specifies the Identity of the policy to assign to the user or group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +This is the identifier of the user that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Forces the policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md similarity index 64% rename from skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md index 790db56c8c..cbe96c09cb 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md @@ -1,33 +1,38 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsmessagingpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy +applicable: Microsoft Teams title: Grant-CsTeamsMessagingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsTeamsMessagingPolicy ## SYNOPSIS -Assigns a teams messaging policy at the per-user scope. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. - +Assigns a teams messaging policy at the per-user scope. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. ## SYNTAX ### Identity (Default) ``` -Grant-CsTeamsMessagingPolicy [[-Identity] ] [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsTeamsMessagingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] ``` ### GrantToTenant ``` -Grant-CsTeamsMessagingPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +Grant-CsTeamsMessagingPolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMessagingPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -85,7 +90,7 @@ Indicates the Identity of the user account the policy should be assigned to. Use ```yaml Type: UserIdParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False @@ -95,6 +100,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru ```yaml @@ -154,11 +204,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.AD.UserIdParameter - ## OUTPUTS ### System.Object @@ -166,4 +218,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Grant-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md similarity index 51% rename from skype/skype-ps/skype/Grant-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md index 120fb07085..9ca488f23b 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md @@ -1,119 +1,187 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsmobilitypolicy -applicable: Microsoft Teams, Skype for Business Online -title: Grant-CsTeamsMobilityPolicy -schema: 2.0.0 -manager: ritikag -ms.reviewer: ritikag ---- - - -# Grant-CsTeamsMobilityPolicy - -## SYNOPSIS -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -## SYNTAX - -### Identity (Default) -``` -Grant-CsTeamsMobilityPolicy [[-Identity] ] [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### GrantToTenant -``` -Grant-CsTeamsMobilityPolicy [-PolicyName] [-Tenant ] [-DomainController ] - [-PassThru] [-Global] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Assigns a teams mobility policy at the per-user scope. - -The Grant-CsTeamsMobilityPolicy cmdlet lets an Admin assign a custom teams mobility policy to a user. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Grant-CsTeamsMobilityPolicy -PolicyName SalesPolicy -Identity "Ken Myer" -``` -Assigns a custom policy "Sales Policy" to the user "Ken Myer" - -## 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 -The User Id of the user to whom the policy is being assigned. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyName -The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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.Rtc.Management.AD.UserIdParameter - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Grant-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Grant-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsMobilityPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant +``` +Grant-CsTeamsMobilityPolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsMobilityPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Assigns a teams mobility policy at the per-user scope. + +The Grant-CsTeamsMobilityPolicy cmdlet lets an Admin assign a custom teams mobility policy to a user. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMobilityPolicy -PolicyName SalesPolicy -Identity "Ken Myer" +``` +Assigns a custom policy "Sales Policy" to the user "Ken Myer" + +## 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 +The User Id of the user to whom the policy is being assigned. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the Global policy, you can assign $Null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..de38261c46 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,85 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Grant-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Grant-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +Grant-CsTeamsRecordingRollOutPolicy -Identity -PolicyName [] +``` + +## DESCRIPTION +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The Grant-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to assign a CsTeamsRecordingRollOutPolicy at the per-user scope. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsMeetingPolicy -identity "Ken Myer" -PolicyName OrganizerPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the OrganizerPolicy + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```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/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..e9460ea3d0 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,204 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsroomvideoteleconferencingpolicy +title: Grant-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Assigns a TeamsRoomVideoTeleConferencingPolicy to a Teams Room Alias on a per-room or per-Group basis. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsRoomVideoTeleConferencingPolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## 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 +``` + +### -Global + +When you use this cmdlet without specifying a identity, the policy applies to all rooms in your tenant, except any that have an explicit policy assignment. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The alias of the Teams room that the IT admin is granting this PolicyName to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Allows the user to indicate whether the cmdlet passes an output object through the pipeline, in this case, after a process is stopped. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Corresponds to the name of the policy under -Identity from the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..4eb7f30ac5 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Grant-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS + +Assigns a specific Teams shared calling routing policy to a user, a group of users, or sets the Global policy instance. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsSharedCallingRoutingPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsSharedCallingRoutingPolicy [[-PolicyName] ] -Identity [] +``` + +### GrantToTenant +``` +Grant-CsTeamsSharedCallingRoutingPolicy -Global [[-PolicyName] ] [-Force] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsSharedCallingRoutingPolicy [-Group] [[-PolicyName] ] -Rank [] +``` + +## EXAMPLES + +### EXAMPLE 1 +``` +Grant-CsTeamsSharedCallingRoutingPolicy -Identity "user@contoso.com" -PolicyName "Seattle" +``` +The command shown in Example 1 assigns the per-user Teams shared calling routing policy instance Seattle to the user user@contoso.com. + +### EXAMPLE 2 +``` +Grant-CsTeamsSharedCallingRoutingPolicy -PolicyName "Seattle" -Global +``` +Example 2 assigns the per-user Teams shared calling routing policy instance Seattle to all the users in the organization, except any that have an explicit Teams shared calling routing policy assignment. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be assigned the per-user Teams shared calling routing policy. User identities can be specified using one of the following formats: the user's SIP address, the user's user principal name (UPN), or the user's ObjectId or Identity. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PolicyName +Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Seattle has a PolicyName equal to Seattle. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your organization, except any that have an explicit policy assignment. To prevent a warning when you carry out this operation, specify this parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: (GrantToGroup) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: (GrantToGroup) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +## NOTES +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md index 7d58455674..43875faa32 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy +online version: https://learn.microsoft.com/powershell/module/teams/grant-teamsshiftspolicy +title: Grant-CsTeamsShiftsPolicy schema: 2.0.0 --- @@ -9,16 +10,32 @@ schema: 2.0.0 ## SYNOPSIS -This commandlet supports applying the TeamsShiftsPolicy to users in a tenant. +This cmdlet supports applying the TeamsShiftsPolicy to users in a tenant. ## SYNTAX +### Identity (Default) +```powershell +Grant-CsTeamsShiftsPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsTeamsShiftsPolicy [-Identity] [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Group] [-Rank] [] ``` -Grant-CsTeamsShiftsPolicy [[-Identity] ] [-PolicyName] [] + +### GrantToTenant +```powershell +Grant-CsTeamsShiftsPolicy [[-PolicyName] ] [-Global] [-Force] [] ``` ## DESCRIPTION -This commandlet enables admins to grant Shifts specific policy settings to users in their tenant. +This cmdlet enables admins to grant Shifts specific policy settings to users in their tenant. ## EXAMPLES @@ -60,10 +77,70 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named + +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### Microsoft.Rtc.Management.AD.UserIdParameter @@ -71,14 +148,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) -[New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) -[Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) -[Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..bbe885264d --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,199 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssurvivablebranchappliancepolicy +title: Grant-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsSurvivableBranchAppliancePolicy [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Group] [-Rank ] [-WhatIf] [-Confirm] + [] +``` + +## 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 +``` + +### -Global + +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the user. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Name of the policy to be assigned. The PolicyName is simply the policy Identity without the policy scope, i.e. the "Tag:" prefix. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..d17f961f44 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Grant-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Grant-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to grant a specific Teams Update Management policy to a user. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsUpdateManagementPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-ProgressAction ] + [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Global] [-ProgressAction ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Group] [-Rank ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +Grants a specific Teams Update Management policy to a user or sets a specific Teams Update Management policy as the new effective global policy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsUpdateManagementPolicy -PolicyName "Campaign Policy" -Identity kenmyer@litwareinc.com +``` + +In this example, the policy "Campaign Policy" is granted to the user kenmyer@litwareinc.com. + +## PARAMETERS + +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The identity of the policy to be granted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md new file mode 100644 index 0000000000..54251476e5 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsUpgradePolicy.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +applicable: Microsoft Teams +title: Grant-CsTeamsUpgradePolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Grant-CsTeamsUpgradePolicy + +## SYNOPSIS +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsUpgradePolicy [[-Identity] ] [-MigrateMeetingsToTeams ] [-PassThru] + [[-PolicyName] ] [-MsftInternalProcessingMode ] [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-Force] [-Global] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsUpgradePolicy [-MigrateMeetingsToTeams ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] -Group [-Rank ] + [] +``` + +## DESCRIPTION + +TeamsUpgradePolicy allows administrators to manage the transition from Skype for Business to Teams. As an organization with Skype for Business starts to adopt Teams, administrators can manage the user experience in their organization using the concept of coexistence "mode". Mode defines in which client incoming chats and calls land as well as in what service (Teams or Skype for Business) new meetings are scheduled in. Mode also governs what functionality is available in the Teams client. Finally, prior to upgrading to TeamsOnly mode administrators can use TeamsUpgradePolicy to trigger notifications in the Skype for Business client to inform users of the pending upgrade. + +This cmdlet enables admins to apply TeamsUpgradePolicy to either individual users or to set the default for the entire organization. + +**NOTE**: Earlier versions of this cmdlet used to support -MigrateMeetingsToTeams option. This option is removed in later versions of the module. Tenants must run Start-CsExMeetingMigration. See [Start-CsExMeetingMigrationService](https://learn.microsoft.com/powershell/module/skype/start-csexmeetingmigration). + +Microsoft Teams provides all relevant instances of TeamsUpgradePolicy via built-in, read-only policies. The built-in instances are as follows: + +|Identity|Mode|NotifySfbUsers|Comments| +|---|---|---|---| +|Islands|Islands|False|Default configuration. Allows a single user to evaluate both clients side by side. Chats and calls can land in either client, so users must always run both clients.| +|IslandsWithNotify|Islands|True|Same as Islands and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBOnly|SfBOnly|False|Calling, chat functionality and meeting scheduling in the Teams app are disabled.| +|SfBOnlyWithNotify|SfBOnly|True|Same as SfBOnly and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBWithTeamsCollab|SfBWithTeamsCollab|False|Calling, chat functionality and meeting scheduling in the Teams app are disabled.| +|SfBWithTeamsCollabWithNotify|SfBWithTeamsCollab|True|Same as SfBWithTeamsCollab and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|SfBWithTeamsCollabAndMeetings|SfBWithTeamsCollabAndMeetings|False|Calling and chat functionality in the Teams app are disabled.| +|SfBWithTeamsCollabAndMeetingsWithNotify|SfBWithTeamsCollabAndMeetings|True|Same as SfBWithTeamsCollabAndMeetings and it adds a banner in the Skype for Business client informing the user that Teams will soon replace Skype for Business.| +|UpgradeToTeams|TeamsOnly|False|Use this mode to upgrade users to Teams and to prevent chat, calling, and meeting scheduling in Skype for Business.| +|Global|Islands|False|| + +> [!IMPORTANT] +> TeamsUpgradePolicy can be assigned to any Teams user, whether that user have an on-premises account in Skype for Business Server or not. However, **TeamsOnly mode can only be assigned to a user who is already homed in Skype for Business Online**. This is because interop with Skype for Business users and federation as well as Microsoft 365 Phone System functionality are only possible if the user is homed in Skype for Business Online. In addition, you cannot assign TeamsOnly mode as the tenant-wide default if you have any Skype for Business on-premises deployment (which is detected by presence of a lyncdiscover DNS record that points to a location other than Office 365. To make these users TeamsOnly you must first move these users individually to the cloud using `Move-CsUser`. Once all users have been moved to the cloud, you can [disable hybrid to complete migration to the cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation-disabling-hybrid) and then apply TeamsOnly mode at the tenant level to ensure future users are TeamsOnly by default. + +> [!NOTE] +> +> - TeamsUpgradePolicy is available in both Office 365 and in on-premises versions of Skype for Business Server, but there are differences: +> - In Office 365, admins can specify both coexistence mode and whether to trigger notifications of pending upgrade. +> - In on-premises with Skype for Business Server, the only available option is to trigger notifications. Skype for Business Server 2015 with CU8 or Skype for Business Server 2019 are required. +> - TeamsUpgradePolicy in Office 365 can be granted to users homed on-premises in hybrid deployments of Skype for Business as follows: +> - Coexistence mode is honored by users homed on-premises, however on-premises users cannot be granted the UpgradeToTeams instance (mode=TeamsOnly) of TeamsUpgradePolicy. To be upgraded to TeamsOnly mode, users must be either homed in Skype for Business Online or have no Skype account anywhere. +> - The NotifySfBUsers setting of Office 365 TeamsUpgradePolicy is not honored by users homed on-premises. Instead, the on-premises version of TeamsUpgradePolicy must be used. +> - In Office 365, all relevant instances of TeamsUpgradePolicy are built into the system, so there is no corresponding New cmdlet available. In contrast, Skype for Business Server does not contain built-in instances, so the New cmdlet is available on-premises. Only NotifySfBUsers property is available in on-premises. +> - When granting a user a policy with mode=TeamsOnly or mode=SfBWithTeamsCollabAndMeetings, by default, meetings organized by that user will be migrated to Teams. For details, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). + +When users are in any of the Skype for Business modes (SfBOnly, SfBWithTeamsCollab, SfBWithTeamsCollabAndMeetings), calling and chat functionality in the Teams app are disabled (but chat in the context of a Teams meeting is still allowed). Similarly, when users are in the SfBOnly or SfBWithTeamsCollab modes, meeting scheduling is disabled. For more details, see [Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/microsoftteams/migration-interop-guidance-for-teams-with-skype). + +The `Grant-CsTeamsUpgradePolicy` cmdlet checks the configuration of the corresponding settings in TeamsMessagingPolicy, TeamsCallingPolicy, and TeamsMeetingPolicy to determine if those settings would be superceded by TeamsUpgradePolicy and if so, an informational message is provided in PowerShell. It is not necessary to set these other policy settings. This is for informational purposes only. Below is an example of what the PowerShell warning looks like: + +`Grant-CsTeamsUpgradePolicy -Identity user1@contoso.com -PolicyName SfBWithTeamsCollab` + +**WARNING**: The user `user1@contoso.com` currently has enabled values for: AllowUserChat, AllowPrivateCalling, AllowPrivateMeetingScheduling, AllowChannelMeetingScheduling, however these values will be ignored. This is because you are granting this user TeamsUpgradePolicy with mode=SfBWithTeamsCollab, which causes the Teams client to behave as if they are disabled. + +> [!NOTE] +> These warning messages are not affected by the -WarningAction parameter. + +## EXAMPLES + +### Example 1: Grant Policy to an individual user + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName UpgradeToTeams -Identity mike@contoso.com +``` + +The above cmdlet assigns the "UpgradeToTeams" policy to user Mike@contoso.com. This effectively upgrades the user to Teams only mode. This command will only succeed if the user does not have an on-premises Skype for Business account. + +### Example 2: Remove Policy for an individual user + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName $null -Identity mike@contoso.com +``` + +The above cmdlet removes any policy changes made to user Mike@contoso.com and effectively Inherits the global tenant setting for teams Upgrade. + +### Example 3: Grant Policy to the entire tenant + +```powershell +PS C:\> Grant-CsTeamsUpgradePolicy -PolicyName SfBOnly -Global +``` + +To grant a policy to all users in the org (except any that have an explicit policy assigned), omit the identity parameter. If you do not specify the -Global parameter, you will be prompted to confirm the operation. + +### Example 4 Get a report on existing TeamsUpgradePolicy users (Screen Report) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +``` + +You can get the output on the screen, on CSV or Html format. For Screen Report. + +### Example 5 Get a report on existing TeamsUpgradePolicy users (CSV Report) + +```powershell +$objUsers = Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +$objusers | ConvertTo-Csv -NoTypeInformation | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.csv" +``` + +This will create a CSV file on the Desktop of the current user with the name "TeamsUpgrade.csv" + +### Example 6 Get a report on existing TeamsUpgradePolicy users (HTML Report) + +```powershell +$objUsers = Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* +$objusers | ConvertTo-Html | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.html" +``` + +After running these lines will create an HTML file on the Desktop of the current user with the name "TeamUpgrade.html" + +### Example 7 Get a report on existing TeamsUpgradePolicy users (CSV Report - Oneliner version) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* | ConvertTo-Csv -NoTypeInformation | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.csv" +``` + +This will create a CSV file on the Desktop of the current user with the name "TeamsUpgrade.csv" + +### Example 8 Get a report on existing TeamsUpgradePolicy users (HTML Report - Oneliner Version) + +```powershell +Get-CSOnlineUser | select UserPrincipalName, teamsupgrade* | ConvertTo-Html | Out-File "$env:USERPROFILE\desktop\TeamsUpgrade.html" +``` + +After running these lines will create an HTML file on the Desktop of the current user with the name "TeamUpgrade.html" + +## PARAMETERS + +### -Identity + +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -PolicyName + +The name of the policy instance. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global + +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +Do not use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) + +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) + +[Coexistence with Skype for Business](https://learn.microsoft.com/microsoftteams/coexistence-chat-calls-presence) + +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) + +[Set-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration) + +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..6d3a365fa0 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvdipolicy +title: Grant-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsVdiPolicy + +## SYNOPSIS +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +### Identity (Default) +```powershell +Grant-CsTeamsVdiPolicy [] +``` + +### GrantToUser +```powershell +Grant-CsTeamsVdiPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Group] -Rank [] +``` + +### GrantToTenant +```powershell +Grant-CsTeamsVdiPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy +``` + +In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy + +## PARAMETERS + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PolicyName +The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null. + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md similarity index 82% rename from skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md index 36ed471af8..a6a5f02703 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsvideointeropservicepolicy -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvideointeropservicepolicy +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Grant-CsTeamsVideoInteropServicePolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Grant-CsTeamsVideoInteropServicePolicy @@ -21,18 +21,25 @@ Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join T ### Identity (Default) ``` -Grant-CsTeamsVideoInteropServicePolicy [[-Identity] ] [-PolicyName] - [-Tenant ] [-DomainController ] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsTeamsVideoInteropServicePolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-WhatIf] [-Confirm] [] ``` ### GrantToTenant ``` -Grant-CsTeamsVideoInteropServicePolicy [-PolicyName] [-Tenant ] - [-DomainController ] [-PassThru] [-Global] [-WhatIf] [-Confirm] [] +Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which of the partners to use for cloud video interop. +Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join Teams meetings. You can use the TeamsVideoInteropServicePolicy cmdlets to enable Cloud Video Interop for particular users or for your entire organization. Microsoft provides pre-constructed policies for each of our supported partners that allow you to designate which of the partners to use for cloud video interop. The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. @@ -48,7 +55,7 @@ Q: I assigned CVI policy to a user, but I can't create a VTC meeting with that p A: The policy is cached for 6 hours. Changes to the policy are updated after the cache expires. Check for your changes after 6 hours. -**Frequently used commands that can help idenfity the policy assignment**: +**Frequently used commands that can help identify the policy assignment**: - Command to get full list of user along with their CVI policy: `Get-CsOnlineUser | Format-List UserPrincipalName,TeamsVideoInteropServicePolicy` @@ -213,9 +220,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..1203279e74 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy +title: Grant-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +manager: sonaggarwal +author: emmanuelrocha001 +--- + +# Grant-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsVirtualAppointmentsPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsVirtualAppointmentsPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsVirtualAppointmentsPolicy [[-PolicyName] ] [-Group] -Rank + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsVirtualAppointmentsPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -PolicyName sms-enabled -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName sms-enabled +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Global -PolicyName sms-enabled +``` + +Assigns a given policy to the tenant. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Global -PolicyName sms-enabled +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + diff --git a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md index 20de78567b..e97f8b3ab1 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsVoiceApplicationsPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/grant-csteamsvoiceapplicationspolicy +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy +title: Grant-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 --- @@ -18,9 +19,21 @@ Grant-CsTeamsVoiceApplicationsPolicy [[-Identity] ] [-PassThru] [[-Polic [-WhatIf] [-Confirm] [] ``` -## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. +### GrantToTenant +``` +Grant-CsTeamsVoiceApplicationsPolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsVoiceApplicationsPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] + [] +``` +## DESCRIPTION +TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES @@ -130,6 +143,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -139,16 +182,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) -[Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) - -[Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) - -[Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..b6dcf697af --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,253 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy +title: Grant-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Grant-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet applies an instance of the Teams Workload policy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) + +```powershell +Grant-CsTeamsWorkLoadPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### GrantToTenant + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Global] [-WhatIf] [-Confirm] [] +``` + +### GrantToGroup + +```powershell +Grant-CsTeamsWorkLoadPolicy [-PassThru] [[-PolicyName] ] [-MsftInternalProcessingMode ] + [-Group] [-Rank ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -PolicyName Test -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName Test +``` + +Assigns a given policy to a group. + +### Example 3 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +Assigns a given policy to the tenant. + +### Example 4 + +```powershell +PS C:\> Grant-CsTeamsWorkLoadPolicy -Global -PolicyName Test +``` + +> [!NOTE] +> _Using `$null` in place of a policy name can be used to unassigned a policy instance._ + + +## 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 +``` + +### -Global + +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group + +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the identity of the target user. + +Example: + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName + +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank + +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..35c5297361 --- /dev/null +++ b/teams/teams-ps/teams/Grant-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy +title: Grant-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# Grant-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +## SYNTAX + +### Identity (Default) +``` +Grant-CsTeamsWorkLocationDetectionPolicy [] +``` + +### GrantToUser +``` +Grant-CsTeamsWorkLocationDetectionPolicy -Identity [[-PolicyName] ] [] +``` + +### GrantToGroup +``` +Grant-CsTeamsWorkLocationDetectionPolicy [[-PolicyName] ] [-Group] -Rank + [] +``` + +### GrantToTenant +``` +Grant-CsTeamsWorkLocationDetectionPolicy [[-PolicyName] ] [-Global] [-Force] [] +``` + +## DESCRIPTION + +This cmdlet applies an instance of the TeamsWorkLocationDetectionPolicy to users or groups in a tenant. + +Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -PolicyName sms-policy -Identity testuser@test.onmicrosoft.com +``` + +Assigns a given policy to a user. + +### Example 2 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName wld-policy +``` + +Assigns a given policy to a group. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-policy +``` + +Assigns a given policy to the tenant. + +### Example 3 +```powershell +PS C:\> Grant-CsTeamsWorkLocationDetectionPolicy -Global -PolicyName wld-policy +``` + +Note: _Using $null in place of a policy name can be used to unassigned a policy instance._ + +## PARAMETERS + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +This is the equivalent to `-Identity Global`. + +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +This is the identifier of the group that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: GrantToGroup +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specifies the identity of the target user. + +Example: testuser@test.onmicrosoft.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d + +Use the "Global" Identity if you wish to set the policy for the entire tenant. + +```yaml +Type: String +Parameter Sets: GrantToUser +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled". + +```yaml +Type: String +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. + +```yaml +Type: Int32 +Parameter Sets: GrantToGroup +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 + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTenantDialPlan.md b/teams/teams-ps/teams/Grant-CsTenantDialPlan.md similarity index 63% rename from skype/skype-ps/skype/Grant-CsTenantDialPlan.md rename to teams/teams-ps/teams/Grant-CsTenantDialPlan.md index ab9494786c..9f4245e9a8 100644 --- a/skype/skype-ps/skype/Grant-CsTenantDialPlan.md +++ b/teams/teams-ps/teams/Grant-CsTenantDialPlan.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/grant-cstenantdialplan -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan +applicable: Microsoft Teams title: Grant-CsTenantDialPlan schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,24 +19,24 @@ Use the Grant-CsTenantDialPlan cmdlet to assign an existing tenant dial plan to ### GrantToTenant (Default) ``` -Grant-CsTenantDialPlan [[-PolicyName] ] [-Global] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsTenantDialPlan [[-PolicyName] ] [-Global] [-PassThru] [] ``` ### GrantToGroup ``` -Grant-CsTenantDialPlan [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [-WhatIf] [-Confirm] [] +Grant-CsTenantDialPlan [-Group] [[-PolicyName] ] [-PassThru] [-Rank ] [] ``` ### Identity ``` -Grant-CsTenantDialPlan [[-Identity] ] [[-PolicyName] ] [-PassThru] [-WhatIf] [-Confirm] [] +Grant-CsTenantDialPlan [[-Identity] ] [[-PolicyName] ] [-PassThru] [] ``` ## DESCRIPTION The Grant-CsTenantDialPlan cmdlet assigns an existing tenant dial plan to a user, a group of users, or sets the Global policy instance. Tenant dial plans provide information that is required for Enterprise Voice users to make telephone calls. Users who do not have a valid tenant dial plan cannot make calls by using Enterprise Voice. -A tenant dial plan determines such things as how normalization rules are applied, and whether a prefix must be dialed for external calls. +A tenant dial plan determines such things as how normalization rules are applied. You can check whether a user has been granted a per-user tenant dial plan by calling a command in this format: `Get-CsUserPolicyAssignment -Identity "" -PolicyType TenantDialPlan.` @@ -75,7 +75,7 @@ Sets the parameters of the Global policy instance to the values in the specified Type: SwitchParameter Parameter Sets: (GrantToTenant) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -89,8 +89,8 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -105,8 +105,8 @@ The PolicyName parameter is the name of the tenant dial plan to be assigned. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +Applicable: Microsoft Teams Required: False Position: 1 @@ -122,7 +122,7 @@ Specifies the group used for the group policy assignment. Type: String Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: True Position: 0 @@ -138,7 +138,7 @@ The rank of the policy assignment, relative to other group policy assignments fo Type: Int32 Parameter Sets: (GrantToGroup) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -153,8 +153,8 @@ The Identity parameter identifies the user to whom the policy should be assigned ```yaml Type: String Parameter Sets: (Identity) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +Applicable: Microsoft Teams Required: False Position: 0 @@ -163,53 +163,23 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Skype for Business 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).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. ## RELATED LINKS -[Set-CsTenantDialPlan](set-cstenantdialplan.md) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) -[New-CsTenantDialPlan](new-cstenantdialplan.md) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) -[Remove-CsTenantDialPlan](remove-cstenantdialplan.md) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) -[Get-CsTenantDialPlan](get-cstenantdialplan.md) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md b/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md index 8873389018..6d4fc120b3 100644 --- a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md +++ b/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md @@ -5,7 +5,7 @@ title: Grant-CsUserPolicyPackage author: serdarsoysal ms.author: serdars manager: amitar -online version: https://docs.microsoft.com/powershell/module/teams/grant-csuserpolicypackage +online version: https://learn.microsoft.com/powershell/module/teams/grant-csuserpolicypackage schema: 2.0.0 --- @@ -18,13 +18,13 @@ This cmdlet supports applying a policy package to users in a tenant. Note that t ## SYNTAX ``` -Grant-CsUserPolicyPackage [-Identity] [-PackageName] [] +Grant-CsUserPolicyPackage [-Identity] [-PackageName] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION This cmdlet supports applying a policy package to users in a tenant. Provide one or more user identities to assign the package with all the associated policies. The available policy packages and their definitions can be found by running Get-CsPolicyPackage. The recommended policy package for each user can be found by running Get-CsUserPolicyPackageRecommendation. -For more information on policy packages, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages. +For more information on policy packages, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. ## EXAMPLES @@ -69,6 +69,37 @@ 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 +``` + +### -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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -80,10 +111,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsPolicyPackage](Get-CsPolicyPackage.md) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) -[Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +[Get-CsUserPolicyPackageRecommendation](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackagerecommendation) -[Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +[Get-CsUserPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicypackage) -[New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) +[New-CsBatchPolicyPackageAssignmentOperation](https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicypackageassignmentoperation) diff --git a/skype/skype-ps/skype/Import-CsAutoAttendantHolidays.md b/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md similarity index 88% rename from skype/skype-ps/skype/Import-CsAutoAttendantHolidays.md rename to teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md index 8214bad4a6..aee3150e6e 100644 --- a/skype/skype-ps/skype/Import-CsAutoAttendantHolidays.md +++ b/teams/teams-ps/teams/Import-CsAutoAttendantHolidays.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csautoattendantholidays -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays +applicable: Microsoft Teams title: Import-CsAutoAttendantHolidays schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Import-CsAutoAttendantHolidays @@ -69,7 +69,7 @@ The identity for the AA whose holiday schedules are to be imported. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -85,7 +85,7 @@ The Input parameter specifies the holiday schedule information that is to be imp Type: System.Byte[] Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -100,7 +100,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -110,26 +110,21 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String The Import-CsAutoAttendantHolidays cmdlet accepts a string as the Identity parameter. - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.OAA.Models.HolidayImportResult - ## NOTES - ## RELATED LINKS -[Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) - -[Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) +[Get-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantholidays) diff --git a/skype/skype-ps/skype/Import-CsOnlineAudioFile.md b/teams/teams-ps/teams/Import-CsOnlineAudioFile.md similarity index 66% rename from skype/skype-ps/skype/Import-CsOnlineAudioFile.md rename to teams/teams-ps/teams/Import-CsOnlineAudioFile.md index 97f3a09828..08de362834 100644 --- a/skype/skype-ps/skype/Import-CsOnlineAudioFile.md +++ b/teams/teams-ps/teams/Import-CsOnlineAudioFile.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/import-csonlineaudiofile +online version: https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile applicable: Microsoft Teams title: Import-CsOnlineAudioFile schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,7 +18,7 @@ Use the Import-CsOnlineAudioFile cmdlet to upload a new audio file. ## SYNTAX ```powershell -Import-CsOnlineAudioFile -ApplicationId -FileName -Content +Import-CsOnlineAudioFile -ApplicationId -FileName -Content [] ``` ## DESCRIPTION @@ -28,36 +28,27 @@ The Import-CsOnlineAudioFile cmdlet uploads a new audio file for use with the Au ### Example 1 ```powershell -$content = Get-Content "C:\Media\Hello.wav" -Encoding byte -ReadCount 0 +$content = [System.IO.File]::ReadAllBytes('C:\Media\Hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "Hello.wav" -Content $content ``` -This example creates a new audio file using the WAV content that has a filename of Hello.wav to be used with organizational auto attendants. The stored variable, $audioFile, will be used when running other cmdlets to update the audio file for Auto Attendant, for example [New-CsAutoAttendantPrompt](https://docs.microsoft.com/powershell/module/skype/new-csautoattendantprompt). +This example creates a new audio file using the WAV content that has a filename of Hello.wav to be used with organizational auto attendants. The stored variable, $audioFile, will be used when running other cmdlets to update the audio file for Auto Attendant, for example [New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt). ### Example 2 ```powershell -$content = Get-Content "C:\Media\MOH.wav" -Encoding byte -ReadCount 0 +$content = [System.IO.File]::ReadAllBytes('C:\Media\MOH.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "HuntGroup" -FileName "MOH.wav" -Content $content ``` -This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as a Music On Hold file with a Call Queue. The stored variable, $audioFile, will be used with [Set-CsCallQueue](https://docs.microsoft.com/powershell/module/skype/set-cscallqueue) to provide the audio file id. +This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as a Music On Hold file with a Call Queue. The stored variable, $audioFile, will be used with [Set-CsCallQueue](https://learn.microsoft.com/powershell/module/teams/set-cscallqueue) to provide the audio file id. ### Example 3 ```powershell -$content = Get-Content "C:\Media\MOH.wav" -Encoding byte -ReadCount 0 +$content = [System.IO.File]::ReadAllBytes('C:\Media\MOH.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId TenantGlobal -FileName "MOH.wav" -Content $content ``` -This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as Music On Hold for Microsoft Teams. The stored variable, $audioFile, will be used with [New-CsTeamsCallHoldPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscallholdpolicy) to provide the audio file id. - -### Example 4 -```powershell -$content = Get-Content "C:\Media\MOH.wav" -AsByteStream -ReadCount 0 -$audioFile = Import-CsOnlineAudioFile -ApplicationId 'TenantGlobal' -FileName 'MOH.wav' -Content $content -``` - -This example uses the `-AsByteStream` parameter instead of the `-Encoding byte` parameter. Requires PowerShell 6 and later versions, where `-Encoding byte` is no longer available. The example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as Music On Hold for Microsoft Teams. The stored variable, $audioFile, will be used with [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) to provide the audio file id. - +This example creates a new audio file using the WAV content that has a filename of MOH.wav to be used as Music On Hold for Microsoft Teams. The stored variable, $audioFile, will be used with [New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) to provide the audio file id. ## PARAMETERS @@ -71,7 +62,7 @@ Supported values: - TenantGlobal ```yaml -Type: System.string +Type: String Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -87,7 +78,7 @@ Accept wildcard characters: False The FileName parameter is the name of the audio file. For example, the file name for the file C:\Media\Welcome.wav is Welcome.wav. ```yaml -Type: System.string +Type: String Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -103,7 +94,7 @@ Accept wildcard characters: False The Content parameter represents the content of the audio file. Supported formats are WAV (uncompressed, linear PCM with 8/16/32-bit depth in mono or stereo), WMA (mono only), and MP3. The audio file content cannot be more 5MB. ```yaml -Type: System.Byte[] +Type: Byte[] Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -116,7 +107,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -135,10 +126,8 @@ Auto Attendant and Call Queue before 48 hours after it was imported. You are responsible for independently clearing and securing all necessary rights and permissions to use any music or audio file with your Microsoft Teams service, which may include intellectual property and other rights in any music, sound effects, audio, brands, names, and other content in the audio file from all relevant rights holders, which may include artists, actors, performers, musicians, songwriters, composers, record labels, music publishers, unions, guilds, rights societies, collective management organizations and any other parties who own, control or license the music copyrights, sound effects, audio and other intellectual property rights. ## RELATED LINKS -[Export-CsOnlineAudioFile](Export-CsOnlineAudioFile.md) - -[Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) -[New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) -[Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) diff --git a/skype/skype-ps/skype/New-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md similarity index 67% rename from skype/skype-ps/skype/New-CsApplicationAccessPolicy.md rename to teams/teams-ps/teams/New-CsApplicationAccessPolicy.md index 1c4343506f..1f6d71a39b 100644 --- a/skype/skype-ps/skype/New-CsApplicationAccessPolicy.md +++ b/teams/teams-ps/teams/New-CsApplicationAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csapplicationaccesspolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy +applicable: Microsoft Teams title: New-CsApplicationAccessPolicy schema: 2.0.0 manager: zhengni @@ -21,7 +21,7 @@ Creates a new application access policy. Application access policy contains a li ### Identity ``` -New-CsApplicationAccessPolicy [-Identity ] [-AppIds ] [-Description ] +New-CsApplicationAccessPolicy [-Identity ] [-AppIds ] [-Description ] [] ``` ## DESCRIPTION @@ -46,7 +46,6 @@ PS C:\> New-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds "d39597b The command shown above shows how to create a new policy with a list of (three) app IDs configured. - ## PARAMETERS ### -Identity @@ -56,7 +55,7 @@ Unique identifier assigned to the policy when it was created. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -67,7 +66,7 @@ Accept wildcard characters: False ### -AppIds -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). ```yaml Type: PSListModifier @@ -88,7 +87,7 @@ Specifies the description of the policy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -97,6 +96,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -105,7 +108,7 @@ Accept wildcard characters: False ## RELATED LINKS -[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) -[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) -[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) -[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csapplicationaccesspolicy) diff --git a/skype/skype-ps/skype/New-CsAutoAttendant.md b/teams/teams-ps/teams/New-CsAutoAttendant.md similarity index 80% rename from skype/skype-ps/skype/New-CsAutoAttendant.md rename to teams/teams-ps/teams/New-CsAutoAttendant.md index 3fc551bc63..98e32e7234 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendant.md +++ b/teams/teams-ps/teams/New-CsAutoAttendant.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendant -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendant +applicable: Microsoft Teams title: New-CsAutoAttendant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendant @@ -18,7 +18,7 @@ Use the New-CsAutoAttendant cmdlet to create a new Auto Attendant (AA). ## SYNTAX ```powershell -New-CsAutoAttendant -Name -LanguageId -TimeZoneId -DefaultCallFlow [-CallFlows ] [-CallHandlingAssociations ] [-Operator ] [-VoiceId ] [-EnableVoiceResponse] [-InclusionScope ] [-ExclusionScope ] [-Tenant ] [] +New-CsAutoAttendant -Name -LanguageId -TimeZoneId -DefaultCallFlow [-CallFlows ] [-CallHandlingAssociations ] [-Operator ] [-VoiceId ] [-EnableVoiceResponse] [-InclusionScope ] [-ExclusionScope ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-UserNameExtension ] [-Tenant ] [] ``` ## DESCRIPTION @@ -27,6 +27,12 @@ Each AA can be associated with phone numbers that allow callers to reach specifi You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly created AA gets assigned a random string that serves as the identity of the AA. +> [!CAUTION] +> The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items: +> +> - -HideAuthorizedUsers +> - -UserNameExtension + **NOTES**: - To setup your AA for calling, you need to create an application instance first using `New-CsOnlineApplicationInstance` cmdlet , then associate it with your AA configuration using `New-CsOnlineApplicationInstanceAssociation` cmdlet. @@ -39,7 +45,7 @@ You can create new AAs by using the New-CsAutoAttendant cmdlet; each newly creat ### -------------------------- Example 1 -------------------------- ```powershell -$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User $greetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" @@ -76,7 +82,7 @@ This example creates a new AA named _Main auto attendant_ that has the following ### -------------------------- Example 2 -------------------------- ```powershell -$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId +$operatorObjectId = (Get-CsOnlineUser operator@contoso.com).Identity $operatorEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User $dcfGreetingPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" @@ -188,7 +194,6 @@ New-CsAutoAttendant -Name "Main auto attendant" -DefaultCallFlow $defaultCallFlo # DirectoryLookupScope : # ApplicationInstances : - # Show the auto attendants associated with this holiday schedule: Get-CsOnlineSchedule $christmasSchedule.Id @@ -204,7 +209,7 @@ This example creates two new AAs named _Main auto attendant_ and _Customer Suppo We can see when we ran the Get-CsOnlineSchedule cmdlet at the end, to get the _Christmas Holiday_ schedule information, that the configuration IDs for the newly created AAs have been added to the `AssociatedConfigurationIds` properties of that schedule. This means any updates made to this schedule would reflect in both associated AAs. -Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](Set-CsAutoAttendant.md) cmdlet documentation for examples on how to do that. +Removing an association between an AA and a schedule is as simple as deleting the CallHandlingAssociation of that schedule in the AA you want to modify. Please refer to [Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) cmdlet documentation for examples on how to do that. ### -------------------------- Example 4 -------------------------- ```powershell @@ -214,9 +219,9 @@ $greetingText = "Welcome to Contoso" $mainMenuText = "To reach your party by name, say it now. To talk to Sales, please press 1. To talk to User2 press 2. Please press 0 for operator" $afterHoursText = "Sorry Contoso is closed. Please call back during week days from 7AM to 8PM. Goodbye!" $tz = "Romance Standard Time" -$operatorId = (Get-CsOnlineUser -Identity "sip:user1@contoso.com").ObjectId -$user1Id = (Get-CsOnlineUser -Identity "sip:user2@contoso.com").ObjectId -$salesCQappinstance = (Get-CsOnlineUser -Identity "sales@contoso.com").ObjectId # one of the application instances associated to the Call Queue +$operatorId = (Get-CsOnlineUser -Identity "sip:user1@contoso.com").Identity +$user1Id = (Get-CsOnlineUser -Identity "sip:user2@contoso.com").Identity +$salesCQappinstance = (Get-CsOnlineUser -Identity "sales@contoso.com").Identity # one of the application instances associated to the Call Queue $tr1 = New-CsOnlineTimeRange -Start 07:00 -End 20:00 # After hours @@ -266,7 +271,7 @@ The Name parameter is a friendly name that is assigned to the AA. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -278,13 +283,13 @@ Accept wildcard characters: False ### -LanguageId The LanguageId parameter is the language that is used to read text-to-speech (TTS) prompts. -You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](Get-CsAutoAttendantSupportedLanguage.md) cmdlet. +You can query the supported languages using the [`Get-CsAutoAttendantSupportedLanguage`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) cmdlet. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -296,13 +301,13 @@ Accept wildcard characters: False ### -TimeZoneId The TimeZoneId parameter represents the AA time zone. All schedules are evaluated based on this time zone. -You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](Get-CsAutoAttendantSupportedTimeZone.md) cmdlet. +You can query the supported timezones using the [`Get-CsAutoAttendantSupportedTimeZone`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) cmdlet. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -314,14 +319,13 @@ Accept wildcard characters: False ### -DefaultCallFlow The DefaultCallFlow parameter is the flow to be executed when no other call flow is in effect (for example, during business hours). -You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](New-CsAutoAttendantCallFlow.md) cmdlet. - +You can create the DefaultCallFlow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -333,14 +337,13 @@ Accept wildcard characters: False ### -CallFlows The CallFlows parameter represents call flows, which are required if they are referenced in the CallHandlingAssociations parameter. -You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](New-CsAutoAttendantCallFlow.md) cmdlet. - +You can create CallFlows by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. ```yaml Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -359,7 +362,7 @@ You can create CallHandlingAssociations by using the `New-CsAutoAttendantCallHan Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -373,12 +376,11 @@ The Operator parameter represents the SIP address or PSTN number of the operator You can create callable entities by using the `New-CsAutoAttendantCallableEntity` cmdlet. - ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -393,15 +395,15 @@ The VoiceId parameter represents the voice that is used to read text-to-speech ( You can query the supported voices by using the `Get-CsAutoAttendantSupportedLanguage` cmdlet. You can determine the default voice for a language by issuing the following command: ``` -$language = Get-CsAutoAttendantSupportedLanguage -Identity "en-US"` -$defaultVoice = $language.Voices[0].Gender +$language = Get-CsAutoAttendantSupportedLanguage -Identity "en-US" +$defaultVoice = $language.Voices[0].Id ``` ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -417,7 +419,7 @@ The EnableVoiceResponse parameter indicates whether voice response for AA is ena Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -430,14 +432,13 @@ Accept wildcard characters: False Specifies the users to which call transfers are allowed through directory lookup feature. If not specified, all users in the organization can be reached through directory lookup. -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](New-CsAutoAttendantDialScope.md) cmdlet. - +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -450,14 +451,47 @@ Accept wildcard characters: False Specifies the users to which call transfers are not allowed through directory lookup feature. If not specified, no user in the organization is excluded from directory lookup. -Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](New-CsAutoAttendantDialScope.md) cmdlet. - +Dial scopes can be created by using the [`New-CsAutoAttendantDialScope`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope) cmdlet. ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers +_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ + +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -466,13 +500,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserNameExtension +_Saving an auto attendant configuration through Teams admin center will *remove* this setting._ + +The UserNameExtension parameter is a string that specifies how to extend usernames in dial search by appending additional information after the name. +This parameter is used in dial search when multiple search results are found, as it helps to distinguish users with similar names. Possible values are: + +- None: Default value, which means the username is pronounced as is. +- Office: Adds office information from the user profile. +- Department: Adds department information from the user profile. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: false +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -482,43 +538,40 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.OAA.Models.AutoAttendant - ## NOTES - ## RELATED LINKS -[New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) -[Get-CsAutoAttendant](Get-CsAutoAttendant.md) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) -[Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) -[Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) +[Get-CsAutoAttendantSupportedLanguage](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedlanguage) -[Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) +[Get-CsAutoAttendantSupportedTimeZone](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantsupportedtimezone) -[New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) +[New-CsAutoAttendantCallableEntity](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity) -[New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) -[New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) -[Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) -[Set-CsAutoAttendant](Set-CsAutoAttendant.md) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) -[Update-CsAutoAttendant](Update-CsAutoAttendant.md) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md similarity index 65% rename from skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md rename to teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md index 0fa48f36ff..e5d964c2c4 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendantcallflow -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow +applicable: Microsoft Teams title: New-CsAutoAttendantCallFlow schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendantCallFlow @@ -18,13 +18,12 @@ Use the New-CsAutoAttendantCallFlow cmdlet to create a new call flow. ## SYNTAX ```powershell -New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [-Tenant ] [] +New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [-Tenant ] [-ForceListenMenuEnabled] [] ``` ## DESCRIPTION The New-CsAutoAttendantCallFlow cmdlet creates a new call flow for use with the Auto Attendant (AA) service. The AA service uses the call flow to handle inbound calls by playing a greeting (if present), and provide callers with actions through a menu. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -41,10 +40,10 @@ This example creates a new call flow that renders the "Default Menu" menu. $menuPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "To reach your party by name, enter it now, followed by the pound sign." $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts $menuPrompt -EnableDialByName $greeting = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" -$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting +$callFlow = New-CsAutoAttendantCallFlow -Name "Default Call Flow" -Menu $menu -Greetings $greeting -ForceListenMenuEnabled ``` -This example creates a new call flow that plays a greeting before rendering the "Default Menu" menu. +This example creates a new call flow that plays a greeting before rendering the "Default Menu" menu with Force listen menu enabled. ## PARAMETERS @@ -55,7 +54,7 @@ The Name parameter represents a unique friendly name for the call flow. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -67,14 +66,13 @@ Accept wildcard characters: False ### -Menu The Menu parameter identifies the menu to render when the call flow is executed. -You can create a new menu by using the [`New-CsAutoAttendantMenu`](New-CsAutoAttendantMenu.md) cmdlet. - +You can create a new menu by using the [`New-CsAutoAttendantMenu`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) cmdlet. ```yaml Type: System.Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -86,14 +84,13 @@ Accept wildcard characters: False ### -Greetings If present, the prompts specified by the Greetings parameter (either TTS or Audio) are played before the call flow's menu is rendered. -You can create prompts by using the [`New-CsAutoAttendantPrompt`](New-CsAutoAttendantPrompt.md) cmdlet. - +You can create prompts by using the [`New-CsAutoAttendantPrompt`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) cmdlet. ```yaml Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -108,7 +105,24 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceListenMenuEnabled + +If specified, DTMF and speech inputs will not be processed while the greeting or menu prompt is playing. It will enforce callers to listen to all menu options before making a selection. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -118,22 +132,20 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.Hosted.OAA.Models.CallFlow - ## NOTES ## RELATED LINKS -[New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) +[New-CsAutoAttendantMenu](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu) -[New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantprompt) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantCallHandlingAssociation.md b/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md similarity index 81% rename from skype/skype-ps/skype/New-CsAutoAttendantCallHandlingAssociation.md rename to teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md index 81189aa066..0dd8a74ae2 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantCallHandlingAssociation.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallHandlingAssociation.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendantcallhandlingassociation -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation +applicable: Microsoft Teams title: New-CsAutoAttendantCallHandlingAssociation schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendantCallHandlingAssociation @@ -92,14 +92,13 @@ This example creates the following: ### -CallFlowId The CallFlowId parameter represents the call flow to be associated with the schedule. -You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](New-CsAutoAttendantCallFlow.md) cmdlet. - +You can create a call flow by using the [`New-CsAutoAttendantCallFlow`](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -111,14 +110,13 @@ Accept wildcard characters: False ### -ScheduleId The ScheduleId parameter represents the schedule to be associated with the call flow. -You can create a schedule by using the [`New-CsOnlineSchedule`](New-CsOnlineSchedule.md) cmdlet. Additionally, you can use [`Get-CsOnlineSchedule`](Get-CsOnlineSchedule.md) cmdlet to get the schedules configured for your organization. - +You can create a schedule by using the [New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) cmdlet. additionally, you can use [Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) cmdlet to get the schedules configured for your organization. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -133,12 +131,11 @@ The Type parameter represents the type of the call handling association. Current - `AfterHours` - `Holiday` - ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -154,7 +151,7 @@ The Disable parameter, if set, establishes that the call handling association is Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -178,7 +175,7 @@ If you are using a remote session of Windows PowerShell and are connected only t Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -188,24 +185,22 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.OAA.Models.CallHandlingAssociation - ## NOTES ## RELATED LINKS -[New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) -[`Get-CsOnlineSchedule`](Get-CsOnlineSchedule.md) +[Get-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/get-csonlineschedule) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantCallableEntity.md b/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md similarity index 61% rename from skype/skype-ps/skype/New-CsAutoAttendantCallableEntity.md rename to teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md index f438e8a229..b496fcaaad 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantCallableEntity.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendantcallableentity -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallableentity +applicable: Microsoft Teams title: New-CsAutoAttendantCallableEntity schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendantCallableEntity @@ -18,7 +18,7 @@ The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity. ## SYNTAX ```powershell -New-CsAutoAttendantCallableEntity -Identity -Type [-Tenant ] [-EnableTranscription] [-EnableSharedVoicemailSystemPromptSuppression] [] +New-CsAutoAttendantCallableEntity -Identity -Type [-Tenant ] [-EnableTranscription] [-EnableSharedVoicemailSystemPromptSuppression] [-CallPriority ] [] ``` ## DESCRIPTION @@ -26,6 +26,7 @@ The New-CsAutoAttendantCallableEntity cmdlet lets you create a callable entity f - User - ApplicationEndpoint +- ConfigurationEndpoint - ExternalPstn - SharedVoicemail @@ -53,7 +54,7 @@ $operatorObjectId = (Get-CsOnlineUser operator@contoso.com).ObjectId $callableEntity = New-CsAutoAttendantCallableEntity -Identity $operatorObjectId -Type User ``` -This example gets a user object using Get-CsOnlineUser cmdlet. We then use the AAD ObjectId of that user object to create a user callable entity. +This example gets a user object using Get-CsOnlineUser cmdlet. We then use the Microsoft Entra ObjectId of that user object to create a user callable entity. ### Example 4 ```powershell @@ -61,7 +62,7 @@ $callableEntityId = Find-CsOnlineApplicationInstance -SearchQuery "Main Auto Att $callableEntity = New-CsAutoAttendantCallableEntity -Identity $callableEntityId.Id -Type ApplicationEndpoint ``` -This example gets an application instance by name using Find-CsOnlineApplicationInstance cmdlet. We then use the AAD ObjectId of that application instance to create an application endpoint callable entity. +This example gets an application instance by name using Find-CsOnlineApplicationInstance cmdlet. We then use the Microsoft Entra ObjectId of that application instance to create an application endpoint callable entity. ### Example 5 ```powershell @@ -83,7 +84,7 @@ The Identity parameter represents the ID of the callable entity; this can be eit Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -96,15 +97,19 @@ Accept wildcard characters: False The Type parameter represents the type of the callable entity, which can be any of the following: - User -- ApplicationEndpoint +- ApplicationEndpoint (when transferring to a Resource Account) +- ConfigurationEndpoint (when transferring directly to a nested Auto Attendant or Call Queue) - ExternalPstn - SharedVoicemail +> [!IMPORTANT] +> Nesting Auto attendants and Call queues via ***ConfigurationEndpoint*** isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. + ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -119,7 +124,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -134,8 +139,8 @@ Enables the email transcription of voicemail, this is only supported with shared ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -150,8 +155,8 @@ Suppresses the "Please leave a message after the tone" system prompt when transf ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -160,23 +165,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CallPriority +_Saving an auto attendant configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +The Call Priority of the MenuOption, only applies when the `Type` is `ApplicationEndpoint` or `ConfigurationEndpoint`. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.OAA.Models.CallableEntity - ## NOTES ## RELATED LINKS -[Get-CsOnlineUser](Get-CsOnlineUser.md) +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) -[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantDialScope.md b/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md similarity index 80% rename from skype/skype-ps/skype/New-CsAutoAttendantDialScope.md rename to teams/teams-ps/teams/New-CsAutoAttendantDialScope.md index d71c203c44..acea07c42e 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantDialScope.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantDialScope.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendantdialscope -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantdialscope +applicable: Microsoft Teams title: New-CsAutoAttendantDialScope schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendantDialScope @@ -53,7 +53,7 @@ Indicates that a dial-scope based on groups (distribution lists, security groups Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -71,7 +71,7 @@ Group IDs can be obtained by using the Find-CsGroup cmdlet. Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -86,7 +86,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -96,20 +96,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.OAA.Models.DialScope - ## NOTES ## RELATED LINKS -[Find-CsGroup](Find-CsGroup.md) +[Find-CsGroup](https://learn.microsoft.com/powershell/module/teams/find-csgroup) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantMenu.md b/teams/teams-ps/teams/New-CsAutoAttendantMenu.md similarity index 79% rename from skype/skype-ps/skype/New-CsAutoAttendantMenu.md rename to teams/teams-ps/teams/New-CsAutoAttendantMenu.md index cf9ea0093d..762182a023 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantMenu.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenu.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendantmenu -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenu +applicable: Microsoft Teams title: New-CsAutoAttendantMenu schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendantMenu @@ -24,7 +24,6 @@ New-CsAutoAttendantMenu -Name [-MenuOptions ] [-Prompts ] [ ## DESCRIPTION The New-CsAutoAttendantMenu cmdlet creates a new menu for the Auto Attendant (AA) service. The OAA service uses menus to provide callers with choices, and then takes action based on the selection. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -44,7 +43,6 @@ $menu = New-CsAutoAttendantMenu -Name "Default Menu" -Prompts @($menuPrompt) -Me This example creates a new menu that allows the caller to reach a target by name or the operator by pressing the 0 key, and also defines the Directory Search Method to Dial By Name. - ## PARAMETERS ### -Name @@ -54,7 +52,7 @@ The Name parameter represents a friendly name for the menu. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -68,12 +66,11 @@ The MenuOptions parameter is a list of menu options for this menu. These menu op You can create menu options by using the New-CsAutoAttendantMenuOption cmdlet. - ```yaml Type: System.Collections.Generic.List Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -87,12 +84,11 @@ The Prompts parameter reflects the prompts to play when the menu is activated. You can create new prompts by using the New-CsAutoAttendantPrompt cmdlet. - ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -104,12 +100,11 @@ Accept wildcard characters: False ### -EnableDialByName The EnableDialByName parameter lets users do a directory search by recipient name and get transferred to the party. - ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -119,7 +114,7 @@ Accept wildcard characters: False ``` ### -DirectorySearchMethod -The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://docs.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) +The DirectorySearchMethod parameter lets you define the type of Directory Search Method for the Auto Attendant menu, for more information, see [Set up a Cloud auto attendant](https://learn.microsoft.com/MicrosoftTeams/create-a-phone-system-auto-attendant?WT.mc_id=TeamsAdminCenterCSH) Possible values are @@ -131,7 +126,7 @@ Possible values are Type: Microsoft.Rtc.Management.Hosted.OAA.Models.DirectorySearchMethod Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -146,7 +141,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -156,22 +151,19 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.Hosted.OAA.Models.Menu - ## NOTES ## RELATED LINKS -[New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) -[New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) - +[New-CsAutoAttendantMenuOption](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) +[New-CsAutoAttendantPrompt](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption) diff --git a/skype/skype-ps/skype/New-CsAutoAttendantMenuOption.md b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md similarity index 86% rename from skype/skype-ps/skype/New-CsAutoAttendantMenuOption.md rename to teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md index 1aa818f205..075d0dccbd 100644 --- a/skype/skype-ps/skype/New-CsAutoAttendantMenuOption.md +++ b/teams/teams-ps/teams/New-CsAutoAttendantMenuOption.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csautoattendantmenuoption -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csautoattendantmenuoption +applicable: Microsoft Teams title: New-CsAutoAttendantMenuOption schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsAutoAttendantMenuOption @@ -24,7 +24,6 @@ New-CsAutoAttendantMenuOption -Action -AudioFi ## DESCRIPTION The New-CsAutoAttendantPrompt cmdlet creates a new prompt for the Auto Attendant (AA) service. A prompt is either an audio file that is played, or text that is read aloud to give callers additional information. A prompt can be disabled by setting the ActiveType to None. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -45,10 +44,9 @@ $ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" This example creates a new prompt that reads the supplied text. - ### -------------------------- Example 2 -------------------------- ```powershell -$content = Get-Content "C:\Media\hello.wav" -Encoding byte -ReadCount 0 +$content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content $audioFilePrompt = New-CsAutoAttendantPrompt -AudioFilePrompt $audioFile ``` @@ -57,14 +55,13 @@ This example creates a new prompt that plays the selected audio file. ### -------------------------- Example 3 -------------------------- ```powershell -$content = Get-Content "C:\Media\hello.wav" -Encoding byte -ReadCount 0 +$content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') $audioFile = Import-CsOnlineAudioFile -ApplicationId "OrgAutoAttendant" -FileName "hello.wav" -Content $content $dualPrompt = New-CsAutoAttendantPrompt -ActiveType AudioFile -AudioFilePrompt $audioFile -TextToSpeechPrompt "Welcome to Contoso!" ``` This example creates a new prompt that has both audio file and text-to-speech data, but will play the audio file when the prompt is activated (rendered). - ## PARAMETERS ### -ActiveType @@ -74,12 +71,11 @@ The ActiveType parameter identifies the active type (modality) of the AA prompt. This is explicitly required if both Audio File and TTS prompts are specified. Otherwise, it is inferred. - ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -93,12 +89,11 @@ The AudioFilePrompt parameter represents the audio to play when the prompt is ac This parameter is required when audio file prompts are being created. You can create audio files by using the `Import-CsOnlineAudioFile` cmdlet. - ```yaml Type: Object Parameter Sets: AudioFile, Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -112,12 +107,11 @@ The TextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt that This parameter is required when text to speech prompts are being created. - ```yaml Type: System.String Parameter Sets: TextToSpeech, Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -132,7 +126,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -142,21 +136,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.Hosted.OAA.Models.Prompt - ## NOTES ## RELATED LINKS -[Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) - +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md index f20848955d..e710dfbc0a 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation +online version: https://learn.microsoft.com/powershell/module/teams/new-csbatchpolicyassignmentoperation +title: New-CsBatchPolicyAssignmentOperation schema: 2.0.0 author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsBatchPolicyAssignmentOperation @@ -26,11 +27,11 @@ New-CsBatchPolicyAssignmentOperation [-OperationName ] -Identity -PackageName [-AgentAlertTime ] [-AllowOptOut ] [-DistributionLists ] [-Tenant ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-MusicOnHoldAudioFileId ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowActionCallPriority ] [-OverflowThreshold ] [-TimeoutAction ] [-TimeoutActionTarget ] [-TimeoutActionCallPriority ] [-TimeoutThreshold ] [-NoAgentAction ] [-NoAgentActionTarget ] [-NoAgentActionCallPriority ] [-RoutingMethod ] [-PresenceBasedRouting ] [-ConferenceMode ] [-User ] [-LanguageId ] [-LineUri ] [-OboResourceAccountIds ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ][-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ] [-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ] [-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ] [-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-EnableOverflowSharedVoicemailSystemPromptSuppression ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ] [-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ] [-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ] [-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [-EnableTimeoutSharedVoicemailSystemPromptSuppression ] [-NoAgentApplyTo ] [-NoAgentDisconnectTextToSpeechPrompt ][-NoAgentDisconnectAudioFilePrompt ] [-NoAgentRedirectPersonTextToSpeechPrompt ] [-NoAgentRedirectPersonAudioFilePrompt ] [-NoAgentRedirectVoiceAppTextToSpeechPrompt ] [-NoAgentRedirectVoiceAppAudioFilePrompt ] [-NoAgentRedirectPhoneNumberTextToSpeechPrompt ] [-NoAgentRedirectPhoneNumberAudioFilePrompt ] [-NoAgentRedirectVoicemailTextToSpeechPrompt ] [-NoAgentRedirectVoicemailAudioFilePrompt ] [-NoAgentSharedVoicemailTextToSpeechPrompt ] [-NoAgentSharedVoicemailAudioFilePrompt ] [-EnableNoAgentSharedVoicemailTranscription ] [-EnableNoAgentSharedVoicemailSystemPromptSuppression ] [-ChannelId ] [-ChannelUserObjectId ] [-ShiftsTeamId ] [-ShiftsSchedulingGroupId ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-WelcomeTextToSpeechPrompt ] [-IsCallbackEnabled ] [-CallbackRequestDtmf ] [-WaitTimeBeforeOfferingCallbackInSecond ] [-NumberOfCallsInQueueBeforeOfferingCallback ] [-CallToAgentRatioThresholdBeforeOfferingCallback ] [-CallbackOfferAudioFilePromptResourceId ] [-CallbackOfferTextToSpeechPrompt ] [-CallbackEmailNotificationTarget ] [-ServiceLevelThresholdResponseTimeInSecond ] [-ComplianceRecordingForCallQueueTemplateId ] [-TextAnnouncementForCR ] [-CustomAudioFileAnnouncementForCR ] [-TextAnnouncementForCRFailure ] [-CustomAudioFileAnnouncementForCRFailure ] [-ShouldOverwriteCallableChannelProperty ] [-SharedCallQueueHistoryTemplateId ] [] +``` + +## DESCRIPTION +The New-CsCallQueue cmdlet creates a new Call Queue. + +> [!CAUTION] +> The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items: +> +> - -HideAuthorizedUsers +> - -OverflowActionCallPriority +> - -OverflowRedirectPersonTextToSpeechPrompt +> - -OverflowRedirectPersonAudioFilePrompt +> - -OverflowRedirectVoicemailTextToSpeechPrompt +> - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutActionCallPriority +> - -TimeoutRedirectPersonTextToSpeechPrompt +> - -TimeoutRedirectPersonAudioFilePrompt +> - -TimeoutRedirectVoicemailTextToSpeechPrompt +> - -TimeoutRedirectVoicemailAudioFilePrompt +> - -NoAgentActionCallPriority +> - -NoAgentRedirectPersonTextToSpeechPrompt +> - -NoAgentRedirectPersonAudioFilePrompt +> - -NoAgentRedirectVoicemailTextToSpeechPrompt +> - -NoAgentRedirectVoicemailAudioFilePrompt +> +> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. +> +> - -ShiftsTeamId +> - -ShiftsSchedulingGroupId +> - -ComplianceRecordingForCallQueueTemplateId +> - -TextAnnouncementForCR +> - -CustomAudioFileAnnouncementForCR +> - -TextAnnouncementForCRFailure +> - -CustomAudioFileAnnouncementForCRFailure +> - -SharedCallQueueHistoryTemplateId +> +> [Nesting Auto attendants and Call queues](/microsoftteams/plan-auto-attendant-call-queue#nested-auto-attendants-and-call-queues) without a resource account isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. +> +> Authorized users can't edit call flows with call priorities at this time. + +## EXAMPLES + +### Example 1 +``` +New-CsCallQueue -Name "Help Desk" -UseDefaultMusicOnHold $true +``` + +This example creates a Call Queue for the organization named "Help Desk" using default music on hold. + +### Example 2 +``` +New-CsCallQueue -Name "Help desk" -RoutingMethod Attendant -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -AllowOptOut $false -AgentAlertTime 30 -OverflowThreshold 15 -OverflowAction Forward -OverflowActionTarget 7fd04db1-1c8e-4fdf-9af5-031514ba1358 -TimeoutThreshold 30 -TimeoutAction Disconnect -MusicOnHoldAudioFileId 1e81adaf-7c3e-4db1-9d61-5d135abb1bcc -WelcomeMusicAudioFileId 0b31bbe5-e2a0-4117-9b6f-956bca6023f8 + +``` + +This example creates a Call Queue for the organization named "Help Desk" with music on hold and welcome music audio files. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentAlertTime +The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. The default value is 30 seconds. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 30 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOptOut +The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionLists +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultMusicOnHold +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeMusicAudioFileId +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldAudioFileId +The MusicOnHoldAudioFileId parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowAction +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: DisconnectWithBusy +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionTarget +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverFlowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowThreshold +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutAction +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionTarget +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutThreshold +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 1200 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentApplyTo +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentAction +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionTarget +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a GUID or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a Microsoft 365 Group ID. Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingMethod +The RoutingMethod parameter defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If the routing method is set to RoundRobin, the agents will be called using the Round Robin strategy so that all agents share the call load equally. If the routing method is set to LongestIdle, the agents will be called based on their idle time, that is, the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Attendant +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PresenceBasedRouting +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConferenceMode +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +The Users parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageId +The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter if either OverflowAction or TimeoutAction is set to SharedVoicemail. + +You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OboResourceAccountIds +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. + +Only Call Queue managed by a Teams Channel will be able to use this feature. For more information, refer to [Manage your support Call Queue in Teams](https://support.microsoft.com/office/manage-your-support-call-queue-in-teams-9f07dabe-91c6-4a9b-a545-8ffdddd2504e). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailTextToSpeechPrompt +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailAudioFilePrompt +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailTranscription +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailSystemPromptSuppression +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppAudioFilePrompt +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailTextToSpeechPrompt +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailAudioFilePrompt +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailTranscription +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailSystemPromptSuppression +The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectTextToSpeechPrompt +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectAudioFilePrompt +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppTextToSpeechPrompt +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppAudioFilePrompt +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberAudioFilePrompt +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailTextToSpeechPrompt +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailAudioFilePrompt +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailTranscription +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailSystemPromptSuppression +The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelId +Id of the channel to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelUserObjectId +Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team the channels belongs to. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsTeamId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsSchedulingGroupId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackRequestDtmf + +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitTimeBeforeOfferingCallbackInSecond + +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfCallsInQueueBeforeOfferingCallback + +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallToAgentRatioThresholdBeforeOfferingCallback + +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Minimum value of 1. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferAudioFilePromptResourceId + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferTextToSpeechPrompt + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackEmailNotificationTarget + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS +[Create a Phone System Call Queue](https://support.office.com/article/Create-a-Phone-System-call-queue-67ccda94-1210-43fb-a25b-7b9785f8a061) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) diff --git a/skype/skype-ps/skype/New-CsCallingLineIdentity.md b/teams/teams-ps/teams/New-CsCallingLineIdentity.md similarity index 60% rename from skype/skype-ps/skype/New-CsCallingLineIdentity.md rename to teams/teams-ps/teams/New-CsCallingLineIdentity.md index ba10c77299..93e83c74a1 100644 --- a/skype/skype-ps/skype/New-CsCallingLineIdentity.md +++ b/teams/teams-ps/teams/New-CsCallingLineIdentity.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cscallinglineidentity -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity +applicable: Microsoft Teams title: New-CsCallingLineIdentity schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,44 +18,35 @@ Use the New-CsCallingLineIdentity cmdlet to create a new Caller ID policy for yo ## SYNTAX ``` -New-CsCallingLineIdentity [-Identity] [-BlockIncomingPstnCallerID ] [-CallingIDSubstitute ] [-CompanyName ] -[-Description ] [-EnableUserOverride ] [-ResourceAccount ] [-ServiceNumber ] +New-CsCallingLineIdentity [-Identity] [-BlockIncomingPstnCallerID ] [-CallingIDSubstitute ] [-CompanyName ] +[-Description ] [-EnableUserOverride ] [-ResourceAccount ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION You can either change or block the Caller ID (also called a Calling Line ID) for a user. By default, the Teams or Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can create a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed. -Note: +Note: - Identity must be unique. -- ServiceNumber must be a valid Service Number in the tenant telephone number inventory. -- If CallerIdSubstitute is given as "Service", then ServiceNumber cannot be empty. - If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty. - + ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false ``` This example creates a new Caller ID policy that sets the Caller ID to Anonymous. -### -------------------------- Example 2 -------------------------- -``` -New-CsCallingLineIdentity -Identity "UKOrgAA" -CallingIdSubstitute "Service" -ServiceNumber "14258828080" -EnableUserOverride $false -Verbose -``` - -This example creates a new Caller ID policy that sets the Caller ID to a specified service number. - -### -------------------------- Example 3 -------------------------- +### Example 2 ``` -New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true +New-CsCallingLineIdentity -Identity BlockIncomingCLID -BlockIncomingPstnCallerID $true ``` This example creates a new Caller ID policy that blocks the incoming Caller ID. -### Example 4 +### Example 3 ``` $ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId New-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -EnableUserOverride $false -ResourceAccount $ObjId -CompanyName "Contoso" @@ -63,6 +54,12 @@ New-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -EnableUs This example creates a new Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso +### Example 4 +``` +New-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true +``` + +This example creates a new Caller ID policy that allows Teams users to make anonymous calls. ## PARAMETERS @@ -72,8 +69,8 @@ The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: 1 @@ -85,13 +82,13 @@ Accept wildcard characters: False ### -BlockIncomingPstnCallerID The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. -The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a Lync user, then Caller ID for incoming calls is suppressed/anonymous. +The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a user, then Caller ID for incoming calls is suppressed/anonymous. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -101,13 +98,13 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute -The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, Service, LineUri, and Resource. +The CallingIDSubstitute parameter lets you specify an alternate Caller ID. The default value is LineUri. Supported values are Anonymous, LineUri, and Resource. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -123,7 +120,7 @@ This parameter sets the Calling party name (typically referred to as CNAM) on th Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -138,8 +135,8 @@ The Description parameter briefly describes the Caller ID policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -149,47 +146,33 @@ Accept wildcard characters: False ``` ### -EnableUserOverride -The EnableUserOverride switch lets the user override the Caller ID policy. +The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceAccount -This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://docs.microsoft.com/microsoftteams/manage-resource-accounts +EnableUserOverride has precedence over other settings in the policy unless substitution is set to Anonymous. For example, assume the policy instance has substitution using a resource account and EnableUserOverride is set and enabled by the user. In this case, the outbound caller ID will be blocked and Anonymous will be used. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceNumber -The ServiceNumber parameter lets you add any valid service number for the CallingIdSubstitute. - -Note: Do not add '+' to the Service number. For example, if the Service number is +1425-xxx-xxxx then valid input is 1425xxxxxxx +### -ResourceAccount +This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -199,13 +182,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -215,13 +198,13 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -231,7 +214,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -245,10 +228,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) -[Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) -[Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md new file mode 100644 index 0000000000..772f8f1d49 --- /dev/null +++ b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md @@ -0,0 +1,62 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsCloudCallDataConnection +online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection +schema: 2.0.0 +author: 2012ucp1544 +ms.author: uditagrawal +ms.reviewer: pbafna +manager: subadjat + +--- + +# New-CsCloudCallDataConnection + +## SYNOPSIS +This cmdlet creates an online call data connection. + +## SYNTAX + +```powershell +New-CsCloudCallDataConnection [] +``` + +## DESCRIPTION +This cmdlet creates an online call data connection. If you get an error that the connection already exists, it means that the call data connection already exists for your tenant. In this case, run Get-CsCloudCallDataConnection. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsCloudCallDataConnection + +Token +----- +00000000-0000-0000-0000-000000000000 +``` + +Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. + +## 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 + +The New-CsCloudCallDataConnection cmdlet is only supported in commercial environments from Teams PowerShell Module versions 4.6.0 or later. + +## RELATED LINKS + +[Configure Call Data Connector](https://learn.microsoft.com/skypeforbusiness/hybrid/configure-call-data-connector) +[Get-CsCloudCallDataConnection](https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection) diff --git a/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..f98067448d --- /dev/null +++ b/teams/teams-ps/teams/New-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/New-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: New-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +New-CsComplianceRecordingForCallQueueTemplate -Name -Description -BotId [-RequiredDuringCall ] [-RequiredBeforeCall ] [-CurrentInvitationCount ] [-PairedApplication ] [] +``` + +## DESCRIPTION +Use the New-CsComplianceRecordingForCallQueueTemplate cmdlet to create a Compliance Recording for Call Queues template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsComplianceRecordingForCallQueueTemplate -Name "Customer Service" -Description "Required before/during call" -BotId 14732826-8206-42e3-b51e-6693e2abb698 -RequiredDuringCall $true -RequiredBeforeCall $true +``` + +This example creates a new Compliance Recording for Call Queue template. + +## PARAMETERS + +### -Name +The name of the compliance recording for call queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the compliance recording for call queues template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BotId +The Id of the compliance recording for call queue bot to invite. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall +Indicates if the compliance recording for call queues bot must remain part of the call. +*Strict recording* - if the bot leaves the call, the call will end. + +```yaml +Type: System.Booleen +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCall +Indicates if the compliance recording for call queues bot must be able to join the call. +*Strict recording* - if the bot can't join the call, the call will end. + +```yaml +Type: System.Booleen +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount +The number of concurrent invitations to send to the compliance recording for call queue bot. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PairedApplication +The PairedApplication parameter specifies the paired application for the call queue. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md b/teams/teams-ps/teams/New-CsCustomPolicyPackage.md index fdee85889c..bf6a5dfc6b 100644 --- a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md +++ b/teams/teams-ps/teams/New-CsCustomPolicyPackage.md @@ -5,7 +5,7 @@ title: New-CsCustomPolicyPackage author: sunguchuan ms.author: gucsun manager: dasosby -online version: https://docs.microsoft.com/powershell/module/teams/new-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage schema: 2.0.0 --- @@ -25,7 +25,7 @@ New-CsCustomPolicyPackage -Identity -PolicyList [-Descriptio ## DESCRIPTION -This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages. +This cmdlet creates a custom policy package. It allows the admin to create their own policy packages for the tenant. For more information on policy packages and the policy types available, see [Managing policy packages in Teams](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages). ## EXAMPLES @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -PolicyList -A list of one or more policies to be added in the package. To specifiy the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). +A list of one or more policies to be added in the package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). ```yaml Type: String[] @@ -103,6 +103,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) -[Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) diff --git a/skype/skype-ps/skype/New-CsEdgeAllowAllKnownDomains.md b/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md similarity index 85% rename from skype/skype-ps/skype/New-CsEdgeAllowAllKnownDomains.md rename to teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md index 2d2b1abc38..2aef1fe8ea 100644 --- a/skype/skype-ps/skype/New-CsEdgeAllowAllKnownDomains.md +++ b/teams/teams-ps/teams/New-CsEdgeAllowAllKnownDomains.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csedgeallowallknowndomains -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowallknowndomains +applicable: Microsoft Teams title: New-CsEdgeAllowAllKnownDomains schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsEdgeAllowAllKnownDomains @@ -51,7 +51,7 @@ To configure federation with all known domains, use a set of commands similar to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### -------------------------- Example 1 -------------------------- ``` $x = New-CsEdgeAllowAllKnownDomains @@ -62,28 +62,24 @@ The two commands shown in Example 1 configure the federation settings for the cu To do this, the first command in the example uses the New-CsEdgeAllowAllKnownDomains cmdlet to create an instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowAllKnownDomains object; this instance is stored in a variable named $x. In the second command, the Set-CsTenantFederationConfiguration cmdlet is called along with the AllowedDomains parameter; using $x as the parameter value configures the federation settings to allow all known domains. - - ## 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).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None. The New-CsEdgeAllowAllKnownDomains cmdlet does not accept pipelined input. ## OUTPUTS -### +### Output types The New-CsEdgeAllowAllKnownDomains cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowAllKnownDomains object. ## NOTES ## RELATED LINKS -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) - - +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/skype/skype-ps/skype/New-CsEdgeAllowList.md b/teams/teams-ps/teams/New-CsEdgeAllowList.md similarity index 88% rename from skype/skype-ps/skype/New-CsEdgeAllowList.md rename to teams/teams-ps/teams/New-CsEdgeAllowList.md index de003faf23..051c806683 100644 --- a/skype/skype-ps/skype/New-CsEdgeAllowList.md +++ b/teams/teams-ps/teams/New-CsEdgeAllowList.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csedgeallowlist -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgeallowlist +applicable: Microsoft Teams title: New-CsEdgeAllowList schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsEdgeAllowList @@ -56,7 +56,7 @@ When this command finishes executing, users will only be allowed to communicate ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### -------------------------- Example 1 -------------------------- ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -72,8 +72,7 @@ After the domain object has been created, the `New-CsEdgeAllowList` cmdlet is us With the allowed domain list created, the final command in the example can then use the `Set-CsTenantFederationConfiguration` cmdlet to configure fabrikam.com as the only domain on the allowed domain list for the current tenant. - -### -------------------------- Example 2 -------------------------- +### -------------------------- Example 2 -------------------------- ``` $x = New-CsEdgeDomainPattern -Domain "contoso.com" @@ -88,7 +87,7 @@ Example 2 shows how you can add multiple domains to an allowed domains list. This is done by calling the `New-CsEdgeDomainPattern` cmdlet multiple times (one for each domain to be added to the list), and storing the resulting domain objects in separate variables. Each of those variables can then be added to the allow list created by the `New-CsEdgeAllowList` cmdlet simply by using the AllowedDomain parameter and separating the variables name by using commas. -### -------------------------- Example 3 -------------------------- +### -------------------------- Example 3 -------------------------- ``` $newAllowList = New-CsEdgeAllowList -AllowedDomain $Null @@ -112,8 +111,8 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -123,23 +122,23 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None. The `New-CsEdgeAllowList` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Output types The `New-CsEdgeAllowList` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowList object. ## NOTES ## RELATED LINKS -[New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) +[New-CsEdgeDomainPattern](https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern) -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/skype/skype-ps/skype/New-CsEdgeDomainPattern.md b/teams/teams-ps/teams/New-CsEdgeDomainPattern.md similarity index 84% rename from skype/skype-ps/skype/New-CsEdgeDomainPattern.md rename to teams/teams-ps/teams/New-CsEdgeDomainPattern.md index fdaa70722b..5bc669bc16 100644 --- a/skype/skype-ps/skype/New-CsEdgeDomainPattern.md +++ b/teams/teams-ps/teams/New-CsEdgeDomainPattern.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csedgedomainpattern -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csedgedomainpattern +applicable: Microsoft Teams title: New-CsEdgeDomainPattern schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsEdgeDomainPattern @@ -48,7 +48,7 @@ Instead, you must create a domain object by using the New-CsEdgeDomainPattern cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### -------------------------- Example 1 -------------------------- ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -59,7 +59,6 @@ Example 1 demonstrates how you can assign a single domain to the blocked domains To do this, the first command in the example creates a domain object for the domain fabrikam.com; this is done by calling the New-CsEdgeDomainPattern cmdlet and by saving the resulting domain object in a variable named $x. The second command then uses the Set-CsTenantFederationConfiguration cmdlet and the BlockedDomains parameter to configure fabrikam.com as the only domain blocked by the current tenant. - ## PARAMETERS ### -Domain @@ -73,8 +72,8 @@ Note that you cannot use wildcards when specifying a domain name. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -84,22 +83,21 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None. The New-CsEdgeDomainPattern cmdlet does not accept pipelined input. ## OUTPUTS -### +### Output types The New-CsEdgeDomainPattern cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DomainPattern object. ## NOTES ## RELATED LINKS -[Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) - +[Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) diff --git a/teams/teams-ps/teams/New-CsExternalAccessPolicy.md b/teams/teams-ps/teams/New-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..5534e03ef3 --- /dev/null +++ b/teams/teams-ps/teams/New-CsExternalAccessPolicy.md @@ -0,0 +1,533 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy +applicable: Microsoft Teams +title: New-CsExternalAccessPolicy +schema: 2.0.0 +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# New-CsExternalAccessPolicy + +## SYNOPSIS + +Enables you to create a new external access policy. + +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. + +This cmdlet was introduced in Lync Server 2010. + +For information about external access in Microsoft Teams, see [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) and [Teams and Skype interoperability](https://learn.microsoft.com/microsoftteams/teams-skype-interop) for specific details. + +## SYNTAX + +```powershell +New-CsExternalAccessPolicy [-Identity] + [-AllowedExternalDomains ] + [-BlockedExternalDomains ] + [-CommunicationWithExternalOrgs ] + [-Confirm] + [-Description ] + [-EnableAcsFederationAccess ] + [-EnableFederationAccess ] + [-EnableOutsideAccess ] + [-EnablePublicCloudAudioVideoAccess ] + [-EnableTeamsConsumerAccess ] + [-EnableTeamsConsumerInbound ] + [-EnableTeamsSmsAccess ] + [-EnableXmppAccess ] + [-FederatedBilateralChats ] + [-Force] + [-InMemory] + [-RestrictTeamsConsumerAccessToExternalUserProfiles ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the cmdlet [Set-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration) or Teams Admin Center under the External Access setting. + +When you install Skype for Business Server, a global external access policy is automatically created for you. +In addition to the global policy, you can also create custom external access policies at either the site or the per-user scope. +If you create an external access policy at the site scope, that policy will automatically be assigned to the site upon creation. +If you create an external access policy at the per-user scope, that policy will be created but will not be assigned to any users. +To assign the policy to a user or group of users, use the Grant-CsExternalAccessPolicy cmdlet. + +New external access policies can be created by using the New-CsExternalAccessPolicy cmdlet. +Note that these policies can only be created at the site or the per-user scope; you cannot create a new policy at the global scope. +In addition, you can have only one external access policy per site: if the Redmond site already has been assigned an external access policy you cannot create a second policy for the site. + +The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, InMemory, PipelineVariable, and Tenant + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- +``` +New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True +``` + +The command shown in Example 1 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. +Note that this new policy sets both the EnableFederationAccess and the EnableOutsideAccess properties to True. + +### -------------------------- Example 2 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true +New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false +``` + +In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. + +### -------------------------- Example 3 ------------------------ +``` +New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False +``` + +The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. +Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. + +### -------------------------- EXAMPLE 4 -------------------------- +``` +$x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory + +$x.EnableFederationAccess = $True + +$x.EnableOutsideAccess = $True + +Set-CsExternalAccessPolicy -Instance $x +``` + +Example 4 demonstrates the use of the InMemory parameter; this parameter enables you to create an in-memory-only instance of an external access policy. +After it has been created, you can modify the in-memory-only instance, then use the Set-CsExternalAccessPolicy cmdlet to transform the virtual policy into a real external access policy. + +To do this, the first command in the example uses the New-CsExternalAccessPolicy cmdlet and the InMemory parameter to create a virtual policy with the Identity RedmondAccessPolicy; this virtual policy is stored in a variable named $x. +The next three commands are used to modify two properties of the virtual policy: EnableFederationAccess and the EnableOutsideAccess. +Finally, the last command uses the Set-CsExternalAccessPolicy cmdlet to create an actual per-user external access policy with the Identity RedmondAccessPolicy. +If you do not call the Set-CsExternalAccessPolicy cmdlet, then the virtual policy will disappear as soon as you end your Windows PowerShell session or delete the variable $x. +Should that happen, an external access policy with the Identity RedmondAccessPolicy will never be created. + +### -------------------------- Example 5 ------------------------ +``` +New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") +Set-CsTenantFederationConfiguration -CustomizeFederation $true +``` + +In this example, we create an ExternalAccessPolicy named "GranularFederationExample" that allows communication with specific external domains, namely `example1.com` and `example2.com`. The federation policy is set to restrict communication to only these allowed domains. + +## PARAMETERS + +### -Identity +Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope. + +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. + +For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` + +To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. + +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains allowed to communicate with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `AllowSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains blocked from communicating with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `BlockSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunicationWithExternalOrgs +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Indicates how users assigned to the policy can communicate with external organizations (domains). This setting has 5 possible values: + +- OrganizationDefault: users follow the federation settings specified in `TenantFederationConfiguration`. This is the default value. +- AllowAllExternalDomains: users are allowed to communicate with all domains. +- AllowSpecificExternalDomains: users can communicate with external domains listed in `AllowedExternalDomains`. +- BlockSpecificExternalDomains: users are blocked from communicating with domains listed in `BlockedExternalDomains`. +- BlockAllExternalDomains: users cannot communicate with any external domains. + +The setting is only applicable when `EnableFederationAccess` is set to true. This setting can only be modified in custom policies. In the Global (default) policy, it is fixed to `OrganizationDefault` and cannot be changed. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Required: False +Position: Named +Default value: OrganizationDefault +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcsFederationAccess +Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFederationAccess +Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOutsideAccess +Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePublicCloudAudioVideoAccess +Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. +When set to False, audio and video options in Skype for Business Server will be disabled any time a user is communicating with a public Internet connectivity contact. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerAccess +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerInbound +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsSmsAccess +Allows you to control whether users can have SMS text messaging capabilities within Teams. + +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableXmppAccess +Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedBilateralChats +> [!NOTE] +> Please note that this parameter is in Private Preview. + +This setting enables bi-lateral chats for the users included in the messaging policy. + +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + +Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. + +This policy doesn't apply to meetings, meeting chats, or channels. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictTeamsConsumerAccessToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory + +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new external access policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +None. +The New-CsExternalAccessPolicy cmdlet does not accept pipelined input. + +## OUTPUTS + +### Output types +Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md index 33714bd674..efbf01984f 100644 --- a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment +online version: https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment +title: New-CsGroupPolicyAssignment schema: 2.0.0 author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsGroupPolicyAssignment @@ -22,22 +23,29 @@ New-CsGroupPolicyAssignment -GroupId -PolicyType -PolicyName < ``` ## DESCRIPTION -This cmdlet is used to assign a policy to a security group or distribution list. When creating a group policy assignment, you must specify a rank, which indicates the precedence of that assignment relative to any other group assignments for the same policy type that may exist. The assignment will be applied to users in the group for any user that does not have a direct policy assignment, provided the user does not have any higher ranking assignments from other groups for the same policy type. +> [!NOTE] +> As of May 2023, group policy assignment functionality in Teams PowerShell Module has been extended to support all policy types used in Teams except for the following: +> - Teams App Permission Policy +> - Teams Network Roaming Policy +> - Teams Emergency Call Routing Policy +> - Teams Voice Applications Policy +> - Teams Upgrade Policy +> +> This cmdlet will be deprecated in the future. Going forward, group policy assignment can be performed by using the corresponding Grant-Cs[PolicyType] cmdlet with the '-Group' parameter. + +This cmdlet is used to assign a policy to a Microsoft 365 group, a security group, or a distribution list. When creating a group policy assignment, you must specify a rank, which indicates the precedence of that assignment relative to any other group assignments for the same policy type that may exist. The assignment will be applied to users in the group for any user that does not have a direct policy assignment, provided the user does not have any higher-ranking assignments from other groups for the same policy type. -The group policy assignment rank is set at the time a policy is assigned to a group and it is relative to other group policy assignments of the same policy type. For example, if there are two groups, each assigned a Teams Meeting policy, then one of the group assignments will be rank 1 while the other will be rank 2. It's helpful to think of rank as determining the position of each policy assignment in an ordered list, from highest rank to lowest rank. In fact, rank can be specified as any number, but these are converted into sequential values 1, 2, 3, etc. with 1 being the highest rank. When assigning a policy to a group, set the rank to be the position in the list where you want the new group policy assignment to be. If a rank is not specified, the policy assignment will be given the lowest rank, corresponding to the end of the list. +The group policy assignment rank is set at the time a policy is assigned to a group and it is relative to other group policy assignments of the same policy type. For example, if there are two groups, each assigned a Teams Meeting policy, then one of the group assignments will be rank 1 while the other will be rank 2. It's helpful to think of rank as determining the position of each policy assignment in an ordered list, from highest rank to lowest rank. In fact, rank can be specified as any number, but these are converted into sequential values 1, 2, 3, etc. with 1 being the highest rank. When assigning a policy to a group, set the rank to be the position in the list where you want the new group policy assignment to be. If a rank is not specified, the policy assignment will be given the lowest rank, corresponding to the end of the list. Assignments applied directly to a user will be treated like rank 0, having precedence over all assignments applied via groups. -Once a group policy assignment is created, the policy assignment will be propagated to the members of the group, including users that are added to the group after the assignment was created. Propagation time of the initial policy assignments to members of the group varies based on the number of users in the group. Propagation time for subsequent group membership changes also varies based on the number of users being added or removed from the group. For large groups, propagation to all members may take 24 hours or more. When using group policy assignment, the recommended maximum group membership size is 50,000 users per group. +Once a group policy assignment is created, the policy assignment will be propagated to the members of the group, including users that are added to the group after the assignment was created. Propagation time of the policy assignments to members of the group varies based on the number of users in the group. Propagation time for subsequent group membership changes also varies based on the number of users being added or removed from the group. For large groups, propagation to all members may take 24 hours or more. When using group policy assignment, the recommended maximum group membership size is 50,000 users per group. > [!NOTE] -> - Group policy assignment support is available only for the following policy types: -TeamsAppSetupPolicy (App Setup policies), TeamsCallingPolicy (Calling policies), TeamsCallParkPolicy (Call park policies), TeamsChannelsPolicy, TeamsComplianceRecordingPolicy, TenantDialPlan, TeamsEducationAssignmentsAppPolicy, TeamsMeetingBroadcastPolicy (Live Events policies), TeamsMeetingPolicy (Meeting policies), TeamsMessagingPolicy (Messaging policies), TeamsShiftsPolicy, TeamsUpdateManagementPolicy. > - A given policy type can be assigned to at most 64 groups, across policy instances for that type. -> - Policy assignments are only propagated to users that are direct members of the group; the assignments are not propagated to members of nested groups. -> - Direct user assignments of policy take precedence over any group policy assignments for a given policy type. Group PolicyPolicy assignments only take effect to a user if that user does not have a direct policy assignment. -> - Get-CsOnlineUser only shows *direct* assignments of policy. It does not show the effect of group policy assignments. To view a specific user's effective policy, use `Get-CsUserPolicyAssignment`. This cmdlet shows whether the effective policy is from a direct assignment or from a group, as well as the ranked order of each group policy assignment in the case where a user is a member of more than 1 group with a group policy assignment of the same policy type. For example, to view all TeamsMeetingPolicy assignments for a given user, $user, run the following powershell cmdlet: `Get-CsUserPolicyAssignment -Identity $user -PolicyType TeamsMeetingPolicy|select -ExpandProperty PolicySource`. For details, see [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md). +> - Policy assignments are only propagated to users that are direct members of the group; the assignments are not propagated to members of nested groups. +> - Direct user assignments of policy take precedence over any group policy assignments for a given policy type. Group PolicyPolicy assignments only take effect to a user if that user does not have a direct policy assignment. +> - Get-CsOnlineUser only shows *direct* assignments of policy. It does not show the effect of group policy assignments. To view a specific user's effective policy, use `Get-CsUserPolicyAssignment`. This cmdlet shows whether the effective policy is from a direct assignment or from a group, as well as the ranked order of each group policy assignment in the case where a user is a member of more than 1 group with a group policy assignment of the same policy type. For example, to view all TeamsMeetingPolicy assignments for a given user, $user, run the following powershell cmdlet: `Get-CsUserPolicyAssignment -Identity $user -PolicyType TeamsMeetingPolicy|select -ExpandProperty PolicySource`. For details, see [Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment). > - Group policy assignment is currently not available in the Microsoft 365 DoD deployment. - ## EXAMPLES ### Example 1 @@ -107,20 +115,7 @@ Accept wildcard characters: False ``` ### -PolicyType -The type of the policy to be assigned. -Possible values: -- TeamsAppSetupPolicy -- TeamsCallingPolicy -- TeamsCallParkPolicy -- TeamsChannelsPolicy -- TeamsComplianceRecordingPolicy -- TenantDialPlan -- TeamsEducationAssignmentsAppPolicy -- TeamsMeetingBroadcastPolicy -- TeamsMeetingPolicy -- TeamsMessagingPolicy -- TeamsShiftsPolicy -- TeamsUpdateManagementPolicy +The type of policy to be assigned. ```yaml Type: String @@ -164,7 +159,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -PassThru Returns true when the command succeeds @@ -180,7 +174,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -213,8 +206,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -224,11 +216,8 @@ For more information, see [About CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) - -[Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) - -[Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) +[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment) -[Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md index 50355739ae..80fbe8f586 100644 --- a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber +online version: https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: New-CsHybridTelephoneNumber schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # New-CsHybridTelephoneNumber @@ -15,11 +16,14 @@ schema: 2.0.0 ## SYNOPSIS This cmdlet adds a hybrid telephone number to the tenant. +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the **New-CsOnlineDirectRoutingTelephoneNumberUploadOrder** cmdlet to add a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder?view=teams-ps) + ## SYNTAX ### Identity (Default) ```powershell -New-CsHybridTelephoneNumber -TelephoneNumber [-Force] [] +New-CsHybridTelephoneNumber -TelephoneNumber [-Force] -InputObject [] ``` ## DESCRIPTION @@ -36,12 +40,12 @@ This example adds the hybrid phone number +1 (402) 555-1234. ## PARAMETERS ### -TelephoneNumber -The telephone number to add. The number should be specified with a prefixed "+". The phone number can not have "tel:" prefixed. +The telephone number to add. The number should be specified with a prefixed "+". The phone number can't have "tel:" prefixed. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: True @@ -65,6 +69,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: NewViaIdentity +Aliases: + +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). @@ -81,6 +100,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The cmdlet is only available in GCC High and DoD cloud instances. ## RELATED LINKS -[Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) +[Remove-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber) -[Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) diff --git a/skype/skype-ps/skype/New-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md similarity index 81% rename from skype/skype-ps/skype/New-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md index 2586bc0eab..ba2c63af2f 100644 --- a/skype/skype-ps/skype/New-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/teams/New-CsInboundBlockedNumberPattern.md @@ -1,170 +1,171 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csinboundblockednumberpattern -applicable: Microsoft Teams, Skype for Business Online -title: New-CsInboundBlockedNumberPattern -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: bulenteg -schema: 2.0.0 ---- - -# New-CsInboundBlockedNumberPattern - -## SYNOPSIS -Adds a blocked number pattern to the tenant list. - -## SYNTAX - -### Identity (Default) -``` -New-CsInboundBlockedNumberPattern [-Identity] -Pattern [-Description ] [-Enabled ] - [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsInboundBlockedNumberPattern -Pattern -Name [-Description ] [-Enabled ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet adds a blocked number pattern to the tenant list. An inbound PSTN call from a number that matches the blocked number pattern will be blocked. - -## EXAMPLES - -### Example 1 -```powershell -PS> New-CsInboundBlockedNumberPattern -Description "Avoid Unwanted Automatic Call" -Name "BlockAutomatic" -Pattern "^\+11234567890" -``` - -This example adds a blocked number pattern to block inbound calls from +11234567890 number. - -## PARAMETERS - -### -Description -A friendly description for the blocked number pattern to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -If this parameter is set to True, the inbound calls matching the pattern will be blocked. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -A unique identifier specifying the blocked number pattern to be created. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -A displayable name describing the blocked number pattern to be created. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the calling number must match in order to be blocked. - -```yaml -Type: String -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS - -[Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) - -[Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) - -[Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern +applicable: Microsoft Teams +title: New-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# New-CsInboundBlockedNumberPattern + +## SYNOPSIS +Adds a blocked number pattern to the tenant list. + +## SYNTAX + +### Identity (Default) +``` +New-CsInboundBlockedNumberPattern [-Identity] -Pattern [-Description ] [-Enabled ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsInboundBlockedNumberPattern -Pattern -Name [-Description ] [-Enabled ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet adds a blocked number pattern to the tenant list. An inbound PSTN call from a number that matches the blocked number pattern will be blocked. + +## EXAMPLES + +### Example 1 +```powershell +PS> New-CsInboundBlockedNumberPattern -Description "Avoid Unwanted Automatic Call" -Name "BlockAutomatic" -Pattern "^\+11234567890" +``` + +This example adds a blocked number pattern to block inbound calls from +11234567890 number. + +## PARAMETERS + +### -Description +A friendly description for the blocked number pattern to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +If this parameter is set to True, the inbound calls matching the pattern will be blocked. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier specifying the blocked number pattern to be created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A displayable name describing the blocked number pattern to be created. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the calling number must match in order to be blocked. + +```yaml +Type: String +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) + +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) + +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) diff --git a/skype/skype-ps/skype/New-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md similarity index 75% rename from skype/skype-ps/skype/New-CsInboundExemptNumberPattern.md rename to teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md index b55b011aa6..63ed383946 100644 --- a/skype/skype-ps/skype/New-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/teams/New-CsInboundExemptNumberPattern.md @@ -1,176 +1,177 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csinboundexemptnumberpattern -applicable: Microsoft Teams, Skype for Business Online -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# New-CsInboundExemptNumberPattern - -## SYNOPSIS - -This cmdlet lets you configure a new number pattern that is exempt from tenant call blocking. - -## SYNTAX - -### Identity (Default) - -```powershell -New-CsInboundExemptNumberPattern -Identity -Pattern [-Description ] [-Enabled ] - [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsInboundExemptNumberPattern -Pattern -Name [-Description ] [-Enabled ] - [-WhatIf] [-Confirm] [] -``` - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS> New-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Pattern "^\+?1312555888[2|3]$" -Description "Allow Contoso helpdesk" -Enabled $True -``` - -Creates a new inbound exempt number pattern for the numbers 1 (312) 555-88882 and 1 (312) 555-88883 and enables it - -## PARAMETERS - -### -Description - -Sets the description of the number pattern. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter determines whether the number pattern is enabled for exemption or not. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the exempt number pattern to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -A displayable name describing the exempt number pattern to be created. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern - -A regular expression that the calling number must match in order to be exempt from blocking. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - -```yaml -Type: System.String -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 -``` - -### -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 -``` - -### CommonParameters - -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 - -## OUTPUTS - -## NOTES - -You can use Test-CsInboundBlockedNumberPattern to test your block and exempt phone number ranges. - -## RELATED LINKS - -[Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) - -[Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) - -[Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) - -[Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) - -[Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: New-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# New-CsInboundExemptNumberPattern + +## SYNOPSIS + +This cmdlet lets you configure a new number pattern that is exempt from tenant call blocking. + +## SYNTAX + +### Identity (Default) + +```powershell +New-CsInboundExemptNumberPattern -Identity -Pattern [-Description ] [-Enabled ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsInboundExemptNumberPattern -Pattern -Name [-Description ] [-Enabled ] + [-WhatIf] [-Confirm] [] +``` + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS> New-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Pattern "^\+?1312555888[2|3]$" -Description "Allow Contoso helpdesk" -Enabled $True +``` + +Creates a new inbound exempt number pattern for the numbers 1 (312) 555-88882 and 1 (312) 555-88883 and enables it + +## PARAMETERS + +### -Description + +Sets the description of the number pattern. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter determines whether the number pattern is enabled for exemption or not. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the exempt number pattern to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +A displayable name describing the exempt number pattern to be created. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern + +A regular expression that the calling number must match in order to be exempt from blocking. It is best practice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +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 +``` + +### -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 +``` + +### CommonParameters + +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 + +## OUTPUTS + +## NOTES + +You can use Test-CsInboundBlockedNumberPattern to test your block and exempt phone number ranges. + +## RELATED LINKS + +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) + +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) + +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..0254f15626 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md @@ -0,0 +1,152 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance +applicable: Microsoft Teams +title: New-CsOnlineApplicationInstance +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsOnlineApplicationInstance + +## SYNOPSIS +Creates an application instance in Microsoft Entra ID. + +## SYNTAX + +``` +New-CsOnlineApplicationInstance [-UserPrincipalName] [[-ApplicationId] ] [[-DisplayName] ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet is used to create an application instance in Microsoft Entra ID. This same cmdlet is also run when creating a new resource account using Teams Admin Center. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +New-CsOnlineApplicationInstance -UserPrincipalName appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" +``` + +This example creates a new application instance for an Auto Attendant with UserPrincipalName "appinstance01@contoso.com", ApplicationId "ce933385-9390-45d1-9512-c8d228074e07", DisplayName "AppInstance01" for the tenant. + +## PARAMETERS + +### -UserPrincipalName +The user principal name. It will be used as the SIP URI too. The user principal name should have an online domain. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md similarity index 83% rename from skype/skype-ps/skype/New-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md index 4fbb4b8856..9cc704f634 100644 --- a/skype/skype-ps/skype/New-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/teams/New-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationinstanceassociation -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation +applicable: Microsoft Teams title: New-CsOnlineApplicationInstanceAssociation schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsOnlineApplicationInstanceAssociation @@ -18,7 +18,7 @@ Use the New-CsOnlineApplicationInstanceAssociation cmdlet to associate either a ## SYNTAX ``` -New-CsOnlineApplicationInstanceAssociation -Identities -ConfigurationId -ConfigurationType [-Tenant ] [] +New-CsOnlineApplicationInstanceAssociation -Identities -ConfigurationId -ConfigurationType [-CallPriority ] [-Tenant ] [] ``` ## DESCRIPTION @@ -119,7 +119,7 @@ The Identities parameter is the identities of application instances to be associ Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -129,13 +129,13 @@ Accept wildcard characters: False ``` ### -ConfigurationId -The ConfigurationId parameter is the identity of the configuration that would be associatied with the provided application instances. +The ConfigurationId parameter is the identity of the configuration that would be associated with the provided application instances. ```yaml Type: System.string Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -156,7 +156,7 @@ It can be one of two values: Type: System.string Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -165,13 +165,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CallPriority +The call priority assigned to calls arriving on this application instance if a priority has not already been assigned. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 + +1 = Very High +2 = High +3 = Normal / Default +4 = Low +5 = Very Low + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 3 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -181,7 +205,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -195,9 +219,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) - -[Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) -[Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) +[Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..f38c088398 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,177 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineaudioconferencingroutingpolicy +title: New-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# New-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet creates a Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +New-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-Description ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsOnlineAudioConferencingRoutingPolicy -Identity Test +``` + +Creates a new Online Audio Conferencing Routing Policy policy with an identity called "Test". + +## 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 +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/skype/skype-ps/skype/New-CsOnlineDateTimeRange.md b/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md similarity index 74% rename from skype/skype-ps/skype/New-CsOnlineDateTimeRange.md rename to teams/teams-ps/teams/New-CsOnlineDateTimeRange.md index 5e02d4df34..ad73e8f554 100644 --- a/skype/skype-ps/skype/New-CsOnlineDateTimeRange.md +++ b/teams/teams-ps/teams/New-CsOnlineDateTimeRange.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinedatetimerange -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange +applicable: Microsoft Teams title: New-CsOnlineDateTimeRange schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsOnlineDateTimeRange @@ -32,33 +32,32 @@ The New-CsOnlineDateTimeRange cmdlet creates a new date-time range to be used wi - "d/m/yyyy H:mm" - "d/m/yyyy" (the time component of the date-time range is set to 00:00) - ## EXAMPLES -### Example 1 +### Example 1 ``` $dtr = New-CsOnlineDateTimeRange -Start "1/1/2017" ``` This example creates a date-time range for spanning from January 1, 2017 12AM to January 2, 2017 12AM. -### Example 2 +### Example 2 ``` $dtr = New-CsOnlineDateTimeRange -Start "24/12/2017 09:00" -End "27/12/2017 00:00" ``` -This example creates a date-time range spanning from December 24, 2017 9AM to December 27, 2017 12AM. +This example creates a date-time range spanning from December 24, 2017 9AM to December 27, 2017 12AM. ## PARAMETERS ### -Start -The Start parameter represents the start bound of the date-time range. +The Start parameter represents the start bound of the date-time range. ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -75,8 +74,8 @@ If not present, the end bound of the date time range is set to 00:00 of the day ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -90,8 +89,8 @@ Accept wildcard characters: False ```yaml Type: System.Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -101,7 +100,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -115,4 +114,4 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) diff --git a/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md b/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md new file mode 100644 index 0000000000..b7d52913b8 --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineDirectRoutingTelephoneNumberUploadOrder.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder +applicable: Microsoft Teams +title: New-CsOnlineDirectRoutingTelephoneNumberUploadOrder +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# New-CsOnlineDirectRoutingTelephoneNumberUploadOrder + +## SYNOPSIS +This cmdlet creates a request to upload Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. The output of the cmdlet is the "orderId" of the asynchronous Direct Routing Number creation operation. A maximum of 10,000 phone numbers can be uploaded at a time. If more than 10,000 numbers need to be uploaded, the requests should be divided into multiple increments of up to 10,000 numbers. + +## SYNTAX + +``` +New-CsOnlineDirectRoutingTelephoneNumberUploadOrder [-TelephoneNumber ] [-StartingNumber ] [-EndingNumber ] [-FileContent ] [] +``` + +## DESCRIPTION +This cmdlet uploads Direct Routing telephone numbers to Microsoft Teams telephone number management inventory. Once uploaded the phone numbers will be visible in Teams PowerShell as acquired Direct Routing phone numbers. + +The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -TelephoneNumber "+123456789" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a new Direct Routing telephone number "+123456789" is being uploaded to Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +### Example 2 +```powershell +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -TelephoneNumber "+123456789,+134567890,+145678901" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c14 +``` + +In this example, a list of telephone numbers is being uploaded to Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +### Example 3 +```powershell +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -StartingNumber "+12000000" -EndingNumber "+12000009" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a range of Direct Routing telephone numbers from "+12000000" to "+12000009" are being uploaded to Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +### Example 4 +```powershell +PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") +PS C:\> New-CsOnlineDirectRoutingTelephoneNumberUploadOrder -FileContent $drlist +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c19 +``` + +In this example, the content of a file with a list of Direct Routing telephone numbers are being uploaded via file upload. The file should be in Comma Separated Values (CSV) file format and only containing the list of DR numbers. Only the content of the file can be passed to the New-CsOnlineDirectRoutingTelephoneNumberUploadOrder cmdlet. Additional fields will be supported via file upload in future releases. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType DirectRoutingNumberCreation -OrderId "orderId"`. + +## PARAMETERS + +### -TelephoneNumber +This is the Direct Routing telephone numbers you wish to upload to Microsoft Teams telephone number management inventory. It is comma delimited list of one or more Direct Routing telephone numbers. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartingNumber +This is the starting number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndingNumber +This is the ending number of a range of Direct Routing telephone number you wish to upload to Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileContent +This is the content of a .csv file that includes the Direct Routing telephone numbers to be uploaded to the Microsoft Teams telephone number management inventory. This parameter can be used to upload up to 10,000 numbers at a time. + +```yaml +Type: Byte[] +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES +The cmdlet is available in Teams PowerShell module 6.7.1 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) +[New-CsOnlineTelephoneNumberReleaseOrder](./new-csonlinetelephonenumberreleaseorder.md) \ No newline at end of file diff --git a/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md similarity index 76% rename from skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md index 98f9b4a8e7..18fa5f7f05 100644 --- a/skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md @@ -1,12 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlineliscivicaddress -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress +Module Name: MicrosoftTeams +applicable: Microsoft Teams title: New-CsOnlineLisCivicAddress schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -21,7 +22,8 @@ Use the New-CsOnlineLisCivicAddress cmdlet to create a civic address in the Loca New-CsOnlineLisCivicAddress -CompanyName -CountryOrRegion [-City ] [-CityAlias ] [-CompanyTaxId ] [-Description ] [-Elin ] [-Force] [-HouseNumber ] [-HouseNumberSuffix ] [-Latitude ] [-Longitude ] [-PostalCode ] [-PostDirectional ] [-PreDirectional ] -[-StateOrProvince ] [-StreetName ] [-StreetSuffix ] [-WhatIf] [-Confirm] [] +[-StateOrProvince ] [-StreetName ] [-StreetSuffix ] [-Confidence ] [-IsAzureMapValidationRequired ] [-ValidationStatus ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -66,7 +68,7 @@ NumberOfVoiceUsers : 0 ### Example 1 ```powershell -New-CsOnlineLisCivicAddress -HouseNumber 1 -StreetName 'Microsoft Way' -City Redmond -StateorProvince Washington -Country US -PostalCode 98052 -Description "West Coast Headquarters" -CompanyName Contoso -Latitude 47.63952 -Longitude -122.12781 -Elin MICROSOFT_ELIN +New-CsOnlineLisCivicAddress -HouseNumber 1 -StreetName 'Microsoft Way' -City Redmond -StateorProvince Washington -CountryOrRegion US -PostalCode 98052 -Description "West Coast Headquarters" -CompanyName Contoso -Latitude 47.63952 -Longitude -122.12781 -Elin MICROSOFT_ELIN ``` This example creates a new civic address described as "West Coast Headquarters": 1 Microsoft Way, Redmond WA, 98052 and sets the geo-coordinates. @@ -80,7 +82,7 @@ Specifies the name of your organization. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -97,7 +99,7 @@ Needs to be a valid country code as contained in the ISO 3166-1 alpha-2 specific Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -113,7 +115,7 @@ Specifies the city of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -129,7 +131,7 @@ Specifies the city alias of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -145,7 +147,7 @@ Specifies the company tax identifier of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -161,7 +163,7 @@ Specifies an administrator defined description of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -178,7 +180,7 @@ This is used in Direct Routing EGW scenarios. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -196,7 +198,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -212,7 +214,7 @@ Specifies the numeric portion of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -229,7 +231,7 @@ For example, if the property was multiplexed, the HouseNumberSuffix parameter wo Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -239,15 +241,15 @@ Accept wildcard characters: False ``` ### -Latitude -Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. +Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. Required for all countries except Australia and Japan where it's optional. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -255,15 +257,15 @@ Accept wildcard characters: False ``` ### -Longitude -Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. Required for all countries except Australia and Japan where it's optional. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -277,7 +279,7 @@ Specifies the postal code of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -294,7 +296,7 @@ For example, "425 Smith Avenue NE". Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -311,7 +313,7 @@ For example, "425 NE Smith Avenue". Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -327,7 +329,7 @@ Specifies the state or province of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -343,7 +345,7 @@ Specifies the street name of the new civic address. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -360,7 +362,52 @@ The street suffix will typically be something like street, avenue, way, or boule Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confidence +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationStatus +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -377,7 +424,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -393,7 +440,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -413,8 +460,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](set-csonlineliscivicaddress.md) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](remove-csonlineliscivicaddress.md) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) -[Get-CsOnlineLisCivicAddress](get-csonlineliscivicaddress.md) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) diff --git a/skype/skype-ps/skype/New-CsOnlineLisLocation.md b/teams/teams-ps/teams/New-CsOnlineLisLocation.md similarity index 72% rename from skype/skype-ps/skype/New-CsOnlineLisLocation.md rename to teams/teams-ps/teams/New-CsOnlineLisLocation.md index a37d114043..418b3f5aa2 100644 --- a/skype/skype-ps/skype/New-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/New-CsOnlineLisLocation.md @@ -1,36 +1,24 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinelislocation +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation applicable: Microsoft Teams title: New-CsOnlineLisLocation schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # New-CsOnlineLisLocation ## SYNOPSIS -Use the New-CsOnlineLisLocation cmdlet to either to create a new emergency dispatch location within an existing civic address, or to create both a new civic address and a location assigned to that address. -There can be multiple locations in a civic address. -Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. +Use the New-CsOnlineLisLocation cmdlet to create a new emergency dispatch location within an existing civic address. Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. ## SYNTAX -### ExistingCivicAddress (Default) ``` -New-CsOnlineLisLocation -Location -CivicAddressId [-CityAlias ] [-CompanyName ] [-CompanyTaxId ] [-Confidence ] -[-Elin ] [-Force] [-HouseNumberSuffix ] [-Latitude ] [-Longitude ] [-WhatIf] [-Confirm] [] -``` - -### CreateCivicAddress -``` -New-CsOnlineLisLocation -Location -CountryOrRegion [-CityAlias ] [-CompanyName ] [-CompanyTaxId ] [-Confidence ] -[-Elin ] [-Force] [-HouseNumberSuffix ] [-Latitude ] [-Longitude ] [-City ] [-Description ] [-HouseNumber ] -[-PostalCode ] [-PostDirectional ] [-PreDirectional ] [-StateOrProvince ] [-StreetName ] [-StreetSuffix ] -[-WhatIf] [-Confirm] [] +New-CsOnlineLisLocation -Location -CivicAddressId [-Elin ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,23 +32,14 @@ New-CsOnlineLisLocation -CivicAddressId b39ff77d-db51-4ce5-8d50-9e9c778e1617 -Lo This example creates a new location called "Office 101, 1st Floor" in the civic address specified by its identity. -### Example 2 -```powershell -New-CsOnlineLisLocation -Location "Office 202, 2nd Floor" -CompanyName "Contoso" -HouseNumber 3910 -StreetName 163rd -StreetSuffix St -City Bellevue -StateOrProvince WA -CountryOrRegion US -PostalCode 98004 -Description "New civic address location" -Elin TEST_ELIN -Latitude 47.64499 -Longitude -122.12219 -``` - -This example creates a new civic address and a location assigned to the address. Location is called "Office 202, 2st Floor" with Elin string "TEST_ELIN" and latitude and longitude set. - ## PARAMETERS ### -CivicAddressId -Specifies the unique identifier of the civic address that will contain the new location. -If specified, no other address description parameters are allowed. -Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. +Specifies the unique identifier of the civic address that will contain the new location. Civic address identities can be discovered by using the Get-CsOnlineLisCivicAddress cmdlet. ```yaml Type: Guid -Parameter Sets: ExistingCivicAddress +Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -72,25 +51,11 @@ Accept wildcard characters: False ``` ### -Location -Specifies an administrator-defined description of the new location. -For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +Specifies an administrator-defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". ```yaml Type: String -Parameter Sets: ExistingCivicAddress -Aliases: -Applicable: Microsoft Teams - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: CreateCivicAddress +Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -104,6 +69,8 @@ Accept wildcard characters: False ### -CountryOrRegion Specifies the country or region of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -120,6 +87,8 @@ Accept wildcard characters: False ### -City Specifies the city of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -136,6 +105,8 @@ Accept wildcard characters: False ### -CityAlias Specifies the city alias. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -152,6 +123,8 @@ Accept wildcard characters: False ### -CompanyName Specifies the name of your organization. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -168,6 +141,8 @@ Accept wildcard characters: False ### -CompanyTaxId The company tax ID. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -200,6 +175,8 @@ Accept wildcard characters: False ### -Description Specifies an administrator defined description of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -214,8 +191,7 @@ Accept wildcard characters: False ``` ### -Elin -Specifies the Emergency Location Identification Number. -This is used in Direct Routing EGW scenarios. +Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. ```yaml Type: String @@ -230,25 +206,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -HouseNumber Specifies the numeric portion of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -266,6 +228,8 @@ Accept wildcard characters: False Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -282,6 +246,8 @@ Accept wildcard characters: False ### -Latitude Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -298,6 +264,8 @@ Accept wildcard characters: False ### -Longitude Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -314,6 +282,8 @@ Accept wildcard characters: False ### -PostalCode Specifies the postal code of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -328,8 +298,9 @@ Accept wildcard characters: False ``` ### -PostDirectional -Specifies the directional attribute of the civic address which follows the street name. -For example, "425 Smith Avenue NE". +Specifies the directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE". + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -345,8 +316,9 @@ Accept wildcard characters: False ``` ### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". +Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue". + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -364,6 +336,8 @@ Accept wildcard characters: False ### -StateOrProvince Specifies the state or province of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -380,6 +354,8 @@ Accept wildcard characters: False ### -StreetName Specifies the street name of the civic address. +**Note:** This parameter is not supported and is deprecated. + ```yaml Type: String Parameter Sets: CreateCivicAddress @@ -394,8 +370,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix -Specifies the modifier of the street name. -The street suffix will typically be something like street, avenue, way, or boulevard. +Specifies the modifier of the street name. The street suffix will typically be something like street, avenue, way, or boulevard. + +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -443,6 +420,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -454,8 +447,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) -[Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) -[Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) diff --git a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md similarity index 83% rename from skype/skype-ps/skype/New-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/New-CsOnlinePSTNGateway.md index 2d105372dd..3da8fd129c 100644 --- a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/teams/New-CsOnlinePSTNGateway.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinepstngateway +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway applicable: Microsoft Teams title: New-CsOnlinePSTNGateway schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsOnlinePSTNGateway @@ -17,15 +17,24 @@ Creates a new Session Border Controller (SBC) Configuration that describes the s ## SYNTAX +### Identity (Default) ``` -New-CsOnlinePSTNGateway [-Tenant ] [-Description ] [-Fqdn ] [-SipSignalingPort ] - [-ExcludedCodecs ] [-FailoverResponseCodes ] [-FailoverTimeSeconds ] - [-ForwardCallHistory ] [-ForwardPai ] [-SendSipOptions ] - [-MaxConcurrentSessions ] [-Enabled ] [-MediaBypass ] - [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-GatewayLbrEnabledUserOverride ] [-BypassMode ] - [-InboundTeamsNumberTranslationRules ] [-InboundPSTNNumberTranslationRules ] - [-OutboundTeamsNumberTranslationRules ] [-OutboundPSTNNumberTranslationRules ] [-PidfloSupported ] - [-MediaRelayRoutingLocationOverride ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +New-CsOnlinePSTNGateway [-Identity] -SipSignalingPort [-BypassMode ] [-Description ] [-Enabled ] + [-FailoverResponseCodes ] [-FailoverTimeSeconds ] [-ForwardCallHistory ] [-ForwardPai ] [-GatewayLbrEnabledUserOverride ] + [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] + [-MaxConcurrentSessions ] [-MediaBypass ] [-MediaRelayRoutingLocationOverride ] [-OutboundPstnNumberTranslationRules ] + [-OutboundTeamsNumberTranslationRules ] [-PidfLoSupported ] [-ProxySbc ] [-SendSipOptions ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsOnlinePSTNGateway -SipSignalingPort -Fqdn [-BypassMode ] [-Description ] [-Enabled ] + [-FailoverResponseCodes ] [-FailoverTimeSeconds ] [-ForwardCallHistory ] [-ForwardPai ] [-GatewayLbrEnabledUserOverride ] + [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] + [-MaxConcurrentSessions ] [-MediaBypass ] [-MediaRelayRoutingLocationOverride ] [-OutboundPstnNumberTranslationRules ] + [-OutboundTeamsNumberTranslationRules ] [-PidfLoSupported ] [-ProxySbc ] [-SendSipOptions ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,21 +58,6 @@ This example creates an SBC with FQDN sbc.contoso.com and signaling port 5061. F ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Description Free-format string to describe the gateway. @@ -94,21 +88,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedCodecs -Allows some codecs to be excluded when media is being negotiated between Media Proxy and SBC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -FailoverResponseCodes If Direct Routing receives any 4xx or 6xx SIP error code in response to an outgoing Invite the call is considered completed by default. (Outgoing in this context is a call from a Teams client to the PSTN with traffic flow: Teams Client -> Direct Routing -> SBC -> Telephony network). Setting the SIP codes in this parameter forces Direct Routing @@ -144,21 +123,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ForwardCallHistory Indicates whether call history information will be forwarded to the SBC. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). @@ -237,8 +201,7 @@ Accept wildcard characters: False ``` ### -GatewayLbrEnabledUserOverride -Allow an LBR enabled user working from a network site outside the corporate network, i.e. a network site not configured using tenant network site - typically when working from -home, to make outbound PSTN calls via an LBR enabled gateway. The default value is False. +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml Type: Boolean @@ -256,7 +219,7 @@ Accept wildcard characters: False When creating a new SBC, the identity must be identical to the -FQDN parameter, described above. If the parameter is not defined the Identity will be copied from the -FQDN parameter. The Identity parameter is not mandatory. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: Applicable: Microsoft Teams @@ -267,20 +230,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -MaxConcurrentSessions Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent sessions is 90% or higher than this value. If the parameter is not set, alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. @@ -312,8 +261,6 @@ Accept wildcard characters: False ``` ### -MediaRelayRoutingLocationOverride -This parameter is reserved for use with managed carriers. - Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. ```yaml @@ -328,7 +275,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -SendSipOptions Defines if an SBC will or will not send SIP Options messages. If disabled, the SBC will be excluded from the Monitoring and Alerting system. We highly recommend that you enable SIP Options. The default value is True. @@ -378,7 +324,7 @@ Accept wildcard characters: False This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -392,7 +338,7 @@ Accept wildcard characters: False Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -406,7 +352,7 @@ Accept wildcard characters: False Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -420,9 +366,9 @@ Accept wildcard characters: False Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named Default value: None @@ -445,10 +391,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -ProxySbc +The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml -Type: System.Guid +Type: String Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -475,15 +422,28 @@ 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: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object @@ -492,8 +452,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) diff --git a/skype/skype-ps/skype/New-CsOnlineSchedule.md b/teams/teams-ps/teams/New-CsOnlineSchedule.md similarity index 82% rename from skype/skype-ps/skype/New-CsOnlineSchedule.md rename to teams/teams-ps/teams/New-CsOnlineSchedule.md index 12cb9bcb51..321a1e96c4 100644 --- a/skype/skype-ps/skype/New-CsOnlineSchedule.md +++ b/teams/teams-ps/teams/New-CsOnlineSchedule.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlineschedule -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule +applicable: Microsoft Teams title: New-CsOnlineSchedule schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsOnlineSchedule @@ -19,12 +19,12 @@ Use the New-CsOnlineSchedule cmdlet to create a new schedule. ### WeeklyRecurrentSchedule ```powershell -New-CsOnlineSchedule -Name -WeeklyRecurrentSchedule [-MondayHours ] [-TuesdayHours ] [-WednesdayHours ] [-ThursdayHours ] [-FridayHours ] [-SaturdayHours ] [-SundayHours ] [-Complement] [-Tenant ] [-CommonParameters] +New-CsOnlineSchedule -Name -WeeklyRecurrentSchedule [-MondayHours ] [-TuesdayHours ] [-WednesdayHours ] [-ThursdayHours ] [-FridayHours ] [-SaturdayHours ] [-SundayHours ] [-Complement] [-Tenant ] [] ``` ### FixedSchedule ```powershell -New-CsOnlineSchedule -Name -FixedSchedule [-DateTimeRanges ] [-Tenant ] [-CommonParameters] +New-CsOnlineSchedule -Name -FixedSchedule [-DateTimeRanges ] [-Tenant ] [] ``` ## DESCRIPTION @@ -41,6 +41,7 @@ The New-CsOnlineSchedule cmdlet creates a new schedule for the Auto Attendant (A - For a fixed schedule, at most 10 date-time ranges can be specified. - You can create a new date-time range for a fixed schedule by using the New-CsOnlineDateTimeRange cmdlet. - The return type of this cmdlet composes a member for the underlying type/implementation. For example, in case of the weekly recurrent schedule, you can modify Monday's time ranges through the Schedule.WeeklyRecurrentSchedule.MondayHours property. Similarly, date-time ranges of a fixed schedule can be modified by using the Schedule.FixedSchedule.DateTimeRanges property. +- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation). ## EXAMPLES @@ -95,7 +96,7 @@ The Name parameter represents a unique friendly name for the schedule. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -111,7 +112,7 @@ The WeeklyRecurrentSchedule parameter indicates that a weekly recurrent schedule Type: SwitchParameter Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -127,7 +128,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -143,7 +144,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -159,7 +160,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -175,7 +176,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -191,7 +192,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -207,7 +208,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -223,7 +224,7 @@ List of time ranges for that day. Type: System.Collections.Generic.List Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -241,7 +242,7 @@ For example, if Complement is enabled and the schedule only contains time ranges Type: SwitchParameter Parameter Sets: WeeklyRecurrentSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -257,7 +258,7 @@ The FixedSchedule parameter indicates that a fixed schedule is to be created. Type: SwitchParameter Parameter Sets: FixedSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -273,7 +274,7 @@ List of date-time ranges for a fixed schedule. At most, 10 date-time ranges can Type: System.Collections.Generic.List Parameter Sets: FixedSchedule Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -288,7 +289,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -298,28 +299,26 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule - ## NOTES ## RELATED LINKS -[New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) +[New-CsOnlineTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange) -[New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) +[New-CsOnlineDateTimeRange](https://learn.microsoft.com/powershell/module/teams/new-csonlinedatetimerange) -[New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +[New-CsAutoAttendantCallFlow](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallflow) -[New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) +[New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation) -[New-CsAutoAttendant](New-CsAutoAttendant.md) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md index 4c5d85c41f..e60b5f483c 100644 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder Module Name: MicrosoftTeams title: New-CsOnlineTelephoneNumberOrder schema: 2.0.0 @@ -50,7 +50,7 @@ Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 InventoryType : Subscriber IsManual : False Name : Example 1 -NumberPrefix : +NumberPrefix : NumberType : UserSubscriber Quantity : 1 ReservationExpiryDate : 8/23/2021 5:59:45 PM @@ -74,7 +74,7 @@ PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 2" -Descripti PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId AreaCode : -CivicAddressId : +CivicAddressId : CountryCode : US CreatedAt : 8/23/2021 5:43:44 PM Description : Number prefix search example @@ -83,7 +83,7 @@ Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 InventoryType : Subscriber IsManual : False Name : Example 2 -NumberPrefix : +NumberPrefix : NumberType : UserSubscriber Quantity : 1 ReservationExpiryDate : 8/23/2021 5:59:45 PM @@ -107,7 +107,7 @@ PS C:\> $orderId = New-CsOnlineTelephoneNumberOrder -Name "Example 3" -Descripti PS C:\> $order = Get-CsOnlineTelephoneNumberOrder -OrderId $orderId AreaCode : -CivicAddressId : +CivicAddressId : CountryCode : US CreatedAt : 8/23/2021 5:43:44 PM Description : Area code selection search example @@ -116,7 +116,7 @@ Id : 1efd85ca-dd46-41b3-80a0-2e4c5f87c912 InventoryType : Service IsManual : False Name : Example 3 -NumberPrefix : +NumberPrefix : NumberType : ConferenceTollFree Quantity : 1 ReservationExpiryDate : 8/23/2021 5:59:45 PM @@ -142,7 +142,7 @@ Specifies the telephone number search order name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -157,7 +157,7 @@ Specifies the telephone number search order description. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -167,12 +167,12 @@ Accept wildcard characters: False ``` ### Country -Specifies the telephone number search order country. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries. +Specifies the telephone number search order country/region. Use `Get-CsOnlineTelephoneNumberCountry` to find the supported countries/regions. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -187,7 +187,7 @@ Specifies the telephone number search order number type. Use `Get-CsOnlineTeleph ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -202,7 +202,7 @@ Specifies the telephone number search order quantity. The number of allowed quan ```yaml Type: Integer Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -217,7 +217,7 @@ Specifies the telephone number search order civic address. CivicAddressId is req ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -232,7 +232,7 @@ Specifies the telephone number search order number prefix. NumberPrefix is requi ```yaml Type: Integer Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -247,7 +247,7 @@ Specifies the telephone number search order number area code. AreaCode is requir ```yaml Type: Integer Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -256,16 +256,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) -[Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +[Get-CsOnlineTelephoneNumberCountry](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbercountry) +[Get-CsOnlineTelephoneNumberType](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumbertype) -[New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) -[Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) -[Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) -[Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) +[New-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder) +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[Complete-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/complete-csonlinetelephonenumberorder) +[Clear-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/clear-csonlinetelephonenumberorder) diff --git a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md new file mode 100644 index 0000000000..b9ccb97cab --- /dev/null +++ b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberReleaseOrder.md @@ -0,0 +1,144 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version:online version: https://learn.microsoft.com/powershell/module/teams/New-csonlinetelephonenumberreleaseorder +applicable: Microsoft Teams +title: New-CsOnlineTelephoneNumberReleaseOrder +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# New-CsOnlineTelephoneNumberReleaseOrder + +## SYNOPSIS +This cmdlet creates a request to release Direct Routing telephone numbers from Microsoft Teams telephone number management inventory. + +## SYNTAX + +``` +New-CsOnlineTelephoneNumberReleaseOrder [-TelephoneNumber ] [-StartingNumber ] [-EndingNumber ] [-FileContent ] [] +``` + +## DESCRIPTION +This cmdlet releases existing Direct Routing telephone numbers from Microsoft Teams telephone number management inventory. Once released the phone numbers will not be visible in Teams PowerShell as acquired Direct Routing phone numbers. A maximum of 1,000 phone numbers can be released at a time. If more than 1,000 numbers need to be released, the requests should be divided into multiple increments of up to 1,000 numbers. + +The cmdlet is an asynchronous operation and will return an OrderId as output. You can use the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to check the status of the OrderId, including any error or warning messages that might result from the operation: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a new Direct Routing telephone number "+123456789" is being released from Microsoft Teams telephone number management inventory. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +### Example 2 +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -TelephoneNumber "+123456789,+134567890,+145678901" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a list of Direct Routing telephone numbers are being released from Microsoft Teams telephone number management. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +### Example 3 +```powershell +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -StartingNumber "+12000000" -EndingNumber "+12000009" +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, a range of Direct Routing telephone numbers from "+12000000" to "+12000009" are being released from Microsoft Teams telephone number management. The output of the cmdlet is the OrderId that can be used with the [Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) cmdlet to retrieve the status of the order: `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +### Example 4 +```powershell +PS C:\> $drlist = [System.IO.File]::ReadAllBytes("C:\Users\testuser\DrNumber.csv") +PS C:\> New-CsOnlineTelephoneNumberReleaseOrder -FileContent $drlist +cdf3073a-6fbb-4ade-a8af-e8fa1f3b9c13 +``` + +In this example, the content of a file with a list of Direct Routing telephone numbers are being released via file upload. The file should be in Comma Separated Values (CSV) file format and should only contain the list of DR numbers to be released. The New-CsOnlineTelephoneNumberReleaseOrder cmdlet is only used to pass the content. To read the output of this cmdlet and retrieve the status of your order, you can use OrderId with the [Get-CsOnlineTelephoneNumberOrder](./get-csonlinetelephonenumberorder.md) cmdlet : `Get-CsOnlineTelephoneNumberOrder -OrderType Release -OrderId "orderId"`. + +## PARAMETERS + +### -TelephoneNumber +This is the Direct Routing telephone number you wish to release from Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartingNumber +This is the starting number of a range of Direct Routing telephone number you wish to release from Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndingNumber +This is the ending number of a range of Direct Routing telephone number you wish to release from Microsoft Teams telephone number management inventory. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileContent +This is the content of a .csv file that includes the Direct Routing telephone numbers to be released from the Microsoft Teams telephone number management inventory. This parameter can be used to release up to 1,000 numbers at a time. + +```yaml +Type: Byte[] +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +## NOTES +The cmdlet is available in Teams PowerShell module 6.7.1 or later. + +The cmdlet is only available in commercial and GCC cloud instances. + +## RELATED LINKS +[Get-CsOnlineTelephoneNumberOrder](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumberorder) +[New-CsOnlineDirectRoutingTelephoneNumberUploadOrder](https://learn.microsoft.com/powershell/module/teams/new-csonlinedirectroutingtelephonenumberuploadorder) \ No newline at end of file diff --git a/skype/skype-ps/skype/New-CsOnlineTimeRange.md b/teams/teams-ps/teams/New-CsOnlineTimeRange.md similarity index 76% rename from skype/skype-ps/skype/New-CsOnlineTimeRange.md rename to teams/teams-ps/teams/New-CsOnlineTimeRange.md index 0dcd94c76c..e331b4ffe5 100644 --- a/skype/skype-ps/skype/New-CsOnlineTimeRange.md +++ b/teams/teams-ps/teams/New-CsOnlineTimeRange.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinetimerange -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinetimerange +applicable: Microsoft Teams title: New-CsOnlineTimeRange schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsOnlineTimeRange @@ -45,7 +45,6 @@ $allDayTimeRange = New-CsOnlineTimeRange -Start 00:00 -End 1.00:00 This example creates a 24-hour time range. - ## PARAMETERS ### -Start @@ -54,8 +53,8 @@ The Start parameter represents the start bound of the time range. ```yaml Type: System.TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -70,8 +69,8 @@ The End parameter represents the end bound of the time range. ```yaml Type: System.TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -85,8 +84,8 @@ Accept wildcard characters: False ```yaml Type: System.Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -96,19 +95,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 ### Microsoft.Rtc.Management.Hosted.Online.Models.TimeRange - ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/New-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md similarity index 91% rename from skype/skype-ps/skype/New-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/New-CsOnlineVoiceRoute.md index 5f8fa75517..270d9deed1 100644 --- a/skype/skype-ps/skype/New-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/teams/New-CsOnlineVoiceRoute.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroute -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute +applicable: Microsoft Teams title: New-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -70,7 +70,7 @@ BridgeSourcePhoneNumber is an E.164 formatted Operator Connect Conferencing phon When using BridgeSourcePhoneNumber in an online voice route, the OnlinePstnUsages used in the online voice route should only be used in a corresponding OnlineAudioConferencingRoutingPolicy. The same OnlinePstnUsages should not be used in online voice routes that are not using BridgeSourcePhoneNumber. -For more information about Operator Connect Conferencing, please see [Configure Operator Connect Conferencing](https://docs.microsoft.com/microsoftteams/operator-connect-conferencing-configure). +For more information about Operator Connect Conferencing, please see [Configure Operator Connect Conferencing](https://learn.microsoft.com/microsoftteams/operator-connect-conferencing-configure). ```yaml Type: String @@ -120,7 +120,7 @@ A name that uniquely identifies the online voice route. Voice routes can be defi If Identity is specified, the Name must be left blank. The value of the Identity will be assigned to the Name. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: @@ -229,14 +229,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object @@ -244,8 +242,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) diff --git a/skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md similarity index 64% rename from skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md index 981be247c1..a4646da2fa 100644 --- a/skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroutingpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy +applicable: Microsoft Teams title: New-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -16,11 +16,11 @@ ms.reviewer: Creates a new online voice routing policy. Online voice routing policies manage online PSTN usages for Phone System users. ## SYNTAX + ### Identity ``` -New-CsOnlineVoiceRoutingPolicy [-Tenant ] [-OnlinePstnUsages ] - [-Description ] [-RouteType ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] +New-CsOnlineVoiceRoutingPolicy [-Identity] [-Description ] [-OnlinePstnUsages ] [-RouteType ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -76,26 +76,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier assigned to the policy when it was created. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -110,7 +95,7 @@ Accept wildcard characters: False A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online voice routing policy. The online PSTN usage must be an existing usage (PSTN usages can be retrieved by calling the `Get-CsOnlinePstnUsage` cmdlet). ```yaml -Type: PSListModifier +Type: Object Parameter Sets: (All) Aliases: @@ -136,29 +121,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose online voice routing policy is being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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. @@ -175,16 +137,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object @@ -192,10 +151,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/skype/skype-ps/skype/New-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md similarity index 67% rename from skype/skype-ps/skype/New-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md index e554676968..04a4f92099 100644 --- a/skype/skype-ps/skype/New-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy +applicable: Microsoft Teams title: New-CsOnlineVoicemailPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -16,18 +16,20 @@ ms.reviewer: Creates a new Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. ## SYNTAX + ### Identity (Default) -``` +```powershell New-CsOnlineVoicemailPolicy [-Identity] [-EnableEditingCallAnswerRulesSetting ] [-EnableTranscription ] [-EnableTranscriptionProfanityMasking ] [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] -[-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [] +[-PostAmbleAudioFile ] [-PreambleAudioFile ] [-PreamblePostambleMandatory ] +[-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [-Description ] [] ``` ## DESCRIPTION Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. -By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. - Voicemail transcription is enabled by default - Transcription profanity masking is disabled by default @@ -35,7 +37,7 @@ By default, users enabled for Phone System will be enabled for Cloud Voicemail. - Editing call answer rule settings is enabled by default - Voicemail maximum recording length is set to 5 minutes by default - Primary and secondary system prompt languages are set to null by default and the user's voicemail language setting is used - + Tenant admin would be able to create a customized online voicemail policy to match the organization's requirements. ## EXAMPLES @@ -47,7 +49,6 @@ New-CsOnlineVoicemailPolicy -Identity "CustomOnlineVoicemailPolicy" -MaximumReco The command shown in Example 1 creates a per-user online voicemail policy CustomOnlineVoicemailPolicy with MaximumRecordingLength set to 60 seconds and other fields set to tenant level global value. - ## PARAMETERS ### -Identity @@ -56,8 +57,8 @@ A unique identifier specifying the scope, and in some cases the name, of the pol ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -71,8 +72,8 @@ Controls if editing call answer rule settings are enabled or disabled for a user ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -87,8 +88,8 @@ Allows you to disable or enable voicemail transcription. Possible values are $tr ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -103,8 +104,8 @@ Allows you to disable or enable profanity masking for the voicemail transcriptio ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -119,8 +120,8 @@ Allows you to disable or enable translation for the voicemail transcriptions. Po ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -135,8 +136,24 @@ A duration of voicemail maximum recording length. The length should be between 3 ```yaml Type: Duration Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostambleAudioFile +The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -144,15 +161,46 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -PreambleAudioFile +The audio file to play to the caller before the user's voicemail greeting is played. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreamblePostambleMandatory +Is playing the Pre- or Post-amble mandatory before the caller can leave a message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` ### -PrimarySystemPromptLanguage -The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](/powershell/module/skype/set-csonlinevoicemailusersettings?view=skype-ps) -PromptLanguage for supported languages. +The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -162,13 +210,13 @@ Accept wildcard characters: False ``` ### -SecondarySystemPromptLanguage -The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](/powershell/module/skype/set-csonlinevoicemailusersettings?view=skype-ps) -PromptLanguage for supported languages. +The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. Please see [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -184,7 +232,7 @@ Specifies whether voicemail and transcription data are shared with the service f Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -200,7 +248,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -216,7 +264,23 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -226,7 +290,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -235,10 +299,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoicemailpolicy?view=skype-ps) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md b/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md new file mode 100644 index 0000000000..3c44267712 --- /dev/null +++ b/teams/teams-ps/teams/New-CsSdgBulkSignInRequest.md @@ -0,0 +1,92 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +online version: +title: New-CsSdgBulkSignInRequest +schema: 2.0.0 +--- + +# New-CsSdgBulkSignInRequest + +## SYNOPSIS +Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices. + +## SYNTAX + +``` +New-CsSdgBulkSignInRequest -DeviceDetailsFilePath -Region [] +``` + +## DESCRIPTION +Bulk Sign In for Teams SIP Gateway enables you to sign in a batch of devices in one go. This feature is intended for admins and works for shared devices. +The password for the shared device account is reset at runtime to an unknown value and the cmdlet uses the new credential for fetching token from Entra ID. Admins can sign in shared account remotely and in bulk using this feature. + +## EXAMPLES + +### Example 1 +```powershell +Import-Module MicrosoftTeams +$credential = Get-Credential // Enter your admin's email and password +Connect-MicrosoftTeams -Credential $credential +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC +``` + +This example shows how to connect to Microsoft Teams PowerShell module, and read the output of the New-SdgBulkSignInRequest cmdlet into a variable newBatchResponse. The cmdlet uses Example.csv as the device details file, and SIP Gateway region as APAC. + +### Example 2 +```powershell +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC +$newBatchResponse.BatchId +$getBatchStatusResponse = Get-CsSdgBulkSignInRequestStatus -Batchid $newBatchResponse.BatchId +$getBatchStatusResponse | ft +$getBatchStatusResponse.BatchItem +``` +This example shows how to view the status of a bulk sign in batch. + +## PARAMETERS + +### -DeviceDetailsFilePath +This is the path of the device details CSV file. The CSV file contains two columns - username and hardware ID, where username is of the format FirstFloorLobbyPhone1@contoso.com and hardware ID is the device MAC address in the format 1A-2B-3C-4D-5E-6F + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Region +This is the SIP Gateway region. Possible values include NOAM, EMEA, APAC. + +```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/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..f71b11582d --- /dev/null +++ b/teams/teams-ps/teams/New-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/New-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: New-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# New-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +New-CsSharedCallQueueHistoryTemplate -Name -Description [-IncomingMissedCalls ] [-AnsweredAndOutboundCalls ] [] +``` + +## DESCRIPTION +Use the New-CsSharedCallQueueHistory cmdlet to create a Shared Call Queue History template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsSharedCallQueueHistoryTemplate -Name "Customer Service" -Description "Missed:All Answered:Auth" -IncomingMissedCall XXXXXX -AnsweredAndOutboundCalls XXXXX +``` + +This example creates a new Shared CallQueue History template where incoming missed calls are shown to authorized users and agents and, answered and outbound calls are shown to authorized users only. + +## PARAMETERS + +### -Name +The name of the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the shared call queue history template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncomingMissedCalls +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Off +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnsweredAndOutboundCalls +A description for the shared call queue history template. + +PARAMVALUE: Off | AuthorizedUsersOnly | AuthorizedUsersAndAgents + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Off +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[Get-CsSharedCallQueueHistoryTemplate](./Get-CsSharedCallQueueHistoryTemplate.md) + +[Set-CsSharedCallQueueHistoryTemplate](./Set-CsSharedCallQueueHistoryTemplate.md) + +[Remove-CsSharedCallQueueHistoryTemplate](./Remove-CsSharedCallQueueHistoryTemplate.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/New-CsTeamTemplate.md b/teams/teams-ps/teams/New-CsTeamTemplate.md index f3bde8c355..4230e09bf3 100644 --- a/teams/teams-ps/teams/New-CsTeamTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamTemplate.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate title: New-CsTeamTemplate author: serdarsoysal ms.author: serdars -ms.reviewer: +ms.reviewer: manager: schema: 2.0.0 --- @@ -14,8 +14,7 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet lets you provision a new team template for use in Microsoft Teams. To learn more about team templates, see [Get started with Teams templates in the admin center](/MicrosoftTeams/get-started-with-teams-templates-in-the-admin-console). - +This cmdlet lets you provision a new team template for use in Microsoft Teams. To learn more about team templates, see [Get started with Teams templates in the admin center](https://learn.microsoft.com/microsoftteams/get-started-with-teams-templates-in-the-admin-console). NOTE: The response is a PowerShell object formatted as a JSON for readability. Please refer to the examples for suggested interaction flows for template management. @@ -71,33 +70,33 @@ New-CsTeamTemplate -InputObject -DisplayName (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json +PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US') > input.json # open json in your favorite editor, make changes -PS C:> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) +PS C:\> New-CsTeamTemplate -Locale en-US -Body (Get-Content '.input.json' | Out-String) ``` Step 1: Create new template from copy of existing template. Gets the template JSON file of Template with specified OData ID, creates a JSON file user can make edits in. -Step 2: Create a new template from the JSON file named “input”. +Step 2: Create a new template from the JSON file named "input". ### EXAMPLE 2 ```powershell -PS C:> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' -PS C:> $template | Format-List # show the output object as it would be accessed +PS C:\> $template = Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/com.microsoft.teams.template.AdoptOffice365/Public/en-US' +PS C:\> $template | Format-List # show the output object as it would be accessed -PS C:> $template.Category = $null # unset category to copy from public template -PS C:> $template.DisplayName = 'New Template from object' -PS C:> $template.Channel[1].DisplayName += ' modified' +PS C:\> $template.Category = $null # unset category to copy from public template +PS C:\> $template.DisplayName = 'New Template from object' +PS C:\> $template.Channel[1].DisplayName += ' modified' ## add a new channel to the channel list -PS C:> $template.Channel += ` +PS C:\> $template.Channel += ` @{ ` displayName="test"; ` id="b82b7d0a-6bc9-4fd8-bf09-d432e4ea0475"; ` isFavoriteByDefault=$false; ` } -PS C:> New-CsTeamTemplate -Locale en-US -Body $template +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template ``` Create a template using a complex object syntax. @@ -105,7 +104,7 @@ Create a template using a complex object syntax. ### EXAMPLE 3 ```powershell -PS C:> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` DisplayName='New Template';` ShortDescription='Short Definition';` Description='New Description';` @@ -122,11 +121,14 @@ Channel=@{` }` } -PS C:> New-CsTeamTemplate -Locale en-US -Body $template +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template ``` Create template from scratch +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. + ## PARAMETERS ### -App @@ -199,7 +201,7 @@ Accept wildcard characters: False ### -Classification -Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. ```yaml Type: System.String @@ -331,7 +333,7 @@ Accept wildcard characters: False ### -IsMembershipLimitedToOwner -Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. ```yaml Type: System.Management.Automation.SwitchParameter @@ -395,7 +397,7 @@ Accept wildcard characters: False ### -OwnerUserObjectId -Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. ```yaml Type: System.String @@ -673,7 +675,7 @@ BODY \: The client input for a request to create a template. - `[Description ]`: Gets or sets channel description as displayed to users. - `[DisplayName ]`: Gets or sets channel name as displayed to users. - `[Id ]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration ]`: Represents the configuration of a tab. - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. @@ -687,7 +689,7 @@ BODY \: The client input for a request to create a template. - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure AAD with the set of possible values. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. - `[Description ]`: Gets or sets the team's Description. - `[DiscoverySetting ]`: Governs discoverability of a team. - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. @@ -700,7 +702,7 @@ BODY \: The client input for a request to create a template. - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - `[MemberSetting ]`: Member role settings for the team. - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. @@ -715,7 +717,7 @@ BODY \: The client input for a request to create a template. - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the AAD user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. - `[PublishedBy ]`: Gets or sets published name. - `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. @@ -727,7 +729,7 @@ CHANNEL : Gets or sets the set of channel templates included - `[Description ]`: Gets or sets channel description as displayed to users. - `[DisplayName ]`: Gets or sets channel name as displayed to users. - `[Id ]`: Gets or sets identifier for the channel template. -- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. +- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration ]`: Represents the configuration of a tab. - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. @@ -801,8 +803,8 @@ MESSAGINGSETTING \: Governs use of messaging features w ## RELATED LINKS -- [Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate) -- [New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate) -- [Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate) -- [Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate) +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/New-CsTeamsAIPolicy.md b/teams/teams-ps/teams/New-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..4a7ff4af67 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsAIPolicy.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# New-CsTeamsAIPolicy + +## SYNOPSIS +This cmdlet creates a Teams AI policy. + +## SYNTAX + +```powershell +New-CsTeamsAIPolicy -Identity + [-EnrollFace ] + [-EnrollVoice ] + [-SpeakerAttributionBYOD ] + [-Description ] + [] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet creates a Teams AI policy. If you get an error that the policy already exists, it means that the policy already exists for your tenant. In this case, run Get-CsTeamsAIPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsAIPolicy -Identity Test +``` +Creates a new Teams AI policy with the specified identity. +The newly created policy with value will be printed on success. + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollFace +Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollVoice +Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md similarity index 50% rename from skype/skype-ps/skype/New-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md index 76678eacc0..ff4308f76f 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md @@ -1,55 +1,67 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsapppermissionpolicy -applicable: Skype for Business Online -title: New-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# New-CsTeamsAppPermissionPolicy - -## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . - -## SYNTAX - -``` -New-CsTeamsAppPermissionPolicy [-Force] [-Description ] [-GlobalCatalogAppsType ] [-WhatIf] - [-PrivateCatalogAppsType ] [-Confirm] [[-Identity] ] [-DefaultCatalogAppsType ] - [-Tenant ] [-InMemory] [-GlobalCatalogApps ] [-DefaultCatalogApps ] - [-PrivateCatalogApps ] [-AsJob] -``` - -## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . - -## EXAMPLES - -### Example 1 -Intentionally omitted. - -## 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 +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: New-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# New-CsTeamsAppPermissionPolicy + +## SYNOPSIS + +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . + +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + +## SYNTAX + +``` +New-CsTeamsAppPermissionPolicy [[-Identity] ] + [-Confirm] + [-DefaultCatalogApps ] + [-DefaultCatalogAppsType ] + [-Description ] + [-Force] + [-GlobalCatalogApps ] + [-GlobalCatalogAppsType ] + [-InMemory] + [-PrivateCatalogApps ] + [-PrivateCatalogAppsType ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . + +## EXAMPLES + +### Example 1 +Intentionally omitted. + +## 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/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..ff00d0c8a6 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsappsetuppolicy +applicable: Microsoft Teams +title: New-CsTeamsAppSetupPolicy +schema: 2.0.0 +--- + +# New-CsTeamsAppSetupPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. + +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . + +## SYNTAX + +``` +New-CsTeamsAppSetupPolicy [-Identity] + [-AllowSideLoading ] + [-AllowUserPinning ] + [-AppPresetList ] + [-Confirm] + [-Description ] + [-Force] + [-PinnedAppBarApps ] + [-PinnedCallingBarApps ] + [-PinnedMessageBarApps ] + [-AppPresetMeetingList ] + [-AdditionalCustomizationApps ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. + +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . + +## EXAMPLES + +### Example 1 + +```powershell +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) +``` +Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Policy configuration is used by default. + +### Example 2 + +```powershell +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AllowUserPinning $true +``` +Create a new TeamsAppSetupPolicy. Users can upload a custom app package in the Teams app because AllowSideLoading is set as True, and existing app pins can be added to the list of pinned apps because AllowUserPinning is set as True. + +### Example 3 + +```powershell +# Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps +$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} +$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} +$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} +$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) + +# Settings to pin these apps to the app bar in Teams client. +New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowUserPinning $true -PinnedAppBarApps $PinnedAppBarApps +``` + +Create a new TeamsAppSetupPolicy and pin ActivityApp, ChatApp, TeamsApp apps to the app bar in Teams client by setting these apps as PinnedAppBarApps. + +### Example 4 + +```powershell +# Set VivaConnectionsApp as PinnedMessageBarApps +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$PinnedMessageBarApps = @($VivaConnectionsApp) +# Settings to pin these apps to the messaging extension in Teams client. +Set-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowUserPinning $true -PinnedMessageBarApps $PinnedMessageBarApps +``` + +Create a new TeamsAppSetupPolicy and pin VivaConnections app to the messaging extension in Teams client by setting these apps as PinnedMessageBarApps. + +### Example 5 + +```powershell +# Set VivaConnectionsApp as AppPresetList +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$AppPresetList = @($VivaConnectionsApp) +# Settings to install these apps in your users' personal Teams environment +Set-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AppPresetList $AppPresetList +``` + +Create a new TeamsAppSetupPolicy and install VivaConnections App in users' personal Teams environment by setting these apps as AppPresetList. + +## PARAMETERS + +### -Identity +Name of App setup policy. If empty, all Identities will be used by default. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSideLoading +This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your organization without having to submit it to the Teams app store. Uploading a custom app also lets you test an app before you distribute it more widely by only assigning it to a single user or group of users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserPinning +If you turn this on, the user's existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user's existing app pins will be removed and replaced with the apps defined in this policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetList +Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of the app setup policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedMessageBarApps +Apps are pinned in messaging extensions and into the ellipsis menu. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetMeetingList +This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md similarity index 73% rename from skype/skype-ps/skype/New-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md index 4099eb5b76..e95b230bdc 100644 --- a/skype/skype-ps/skype/New-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/new-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy +title: New-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -26,14 +27,14 @@ The New-CsTeamsAudioConferencingPolicy cmdlet enables administrators to control PS C:\> New-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $False ``` -The command shown in Example 1 uses the New-CsTeamsAudioConferencingPolicy cmdlet to create a new audio-conferencing policy with the Identity “EMEA users”. This policy will use all the default values for a meeting policy except one: AllowTollFreeDialin; in this example, meetings created by users with this policy cannot include Toll Free phone numbers. +The command shown in Example 1 uses the New-CsTeamsAudioConferencingPolicy cmdlet to create a new audio-conferencing policy with the Identity "EMEA users". This policy will use all the default values for a meeting policy except one: AllowTollFreeDialin; in this example, meetings created by users with this policy cannot include Toll Free phone numbers. ### EXAMPLE 2 ``` -PS C:\> New-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $True -MeetingInvitePhoneNumbers “+49695095XXXXX”,”+353156YYYYY”,”+1800856ZZZZZ” +PS C:\> New-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $True -MeetingInvitePhoneNumbers "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ" ``` -The command shown in Example 2 uses the New-CsTeamsAudioConferencingPolicy cmdlet to create a new audio-conferencing policy with the Identity “EMEA users”. This policy will use all the default values for a meeting policy except one: MeetingInvitePhoneNumbers; in this example, meetings created by users with this policy will include the following toll and toll free phone numbers “+49695095XXXXX”,”+353156YYYYY”,”+1800856ZZZZZ”. +The command shown in Example 2 uses the New-CsTeamsAudioConferencingPolicy cmdlet to create a new audio-conferencing policy with the Identity "EMEA users". This policy will use all the default values for a meeting policy except one: MeetingInvitePhoneNumbers; in this example, meetings created by users with this policy will include the following toll and toll free phone numbers "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ". ## PARAMETERS @@ -83,8 +84,7 @@ Accept wildcard characters: False ``` ### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter @@ -156,9 +156,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) - -[Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md similarity index 75% rename from skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md index e31c4cd32d..92744364e9 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md @@ -1,197 +1,191 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamscallholdpolicy -applicable: Microsoft Teams -title: New-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: -manager: abnair -ms.author: jomarque -author: joelhmarquez ---- - -# New-CsTeamsCallHoldPolicy - -## SYNOPSIS - -Creates a new Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. - - -## SYNTAX - -``` -New-CsTeamsCallHoldPolicy [-Tenant ] [-Description ] [-AudioFileId ] - [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams call hold policies are used to customize the call hold experience for teams clients. -When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. - -Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -Description "country music" -AudioFileID "c65233-ac2a27-98701b-123ccc" -``` - -The command shown in Example 1 creates a new, per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. -This policy is assigned the audio file ID: c65233-ac2a27-98701b-123ccc, which is the ID referencing an audio file that was uploaded using the Import-CsOnlineAudioFile cmdlet. - -Any Microsoft Teams users who are assigned this policy will have their call holds customized such that the user being held will hear the audio file specified by AudioFileId. - -## PARAMETERS - -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams call hold policy. - -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier to be assigned to the new Teams call hold policy. - -Use the "Global" Identity if you wish to assign this policy to the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. - -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) - -[Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) - -[Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) - -[Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) - -[Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy +applicable: Microsoft Teams +title: New-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# New-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Creates a new Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +``` +New-CsTeamsCallHoldPolicy [-Identity] [-Description ] [-AudioFileId ] [-StreamingSourceUrl ] [-StreamingSourceAuthType ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -Description "country music" -AudioFileID "c65233-ac2a27-98701b-123ccc" +``` + +The command shown in Example 1 creates a new, per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. +This policy is assigned the audio file ID: c65233-ac2a27-98701b-123ccc, which is the ID referencing an audio file that was uploaded using the Import-CsOnlineAudioFile cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their call holds customized such that the user being held will hear the audio file specified by AudioFileId. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams call hold policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams call hold policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceAuthType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/skype/skype-ps/skype/New-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsTeamsCallParkPolicy.md rename to teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md index f728d45094..ba4ca721a7 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCallParkPolicy.md @@ -1,16 +1,15 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamscallparkpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallparkpolicy +applicable: Microsoft Teams title: New-CsTeamsCallParkPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- - # New-CsTeamsCallParkPolicy ## SYNOPSIS @@ -22,8 +21,8 @@ NOTE: The call park feature currently available in desktop. mobile and web clien ## SYNTAX ### Identity (Default) -``` -New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] [-WhatIf] [-Confirm] [] +```powershell +New-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [[-Identity] ] [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [-Force] [-WhatIf] [-Confirm] [-Description ] [] ``` ## DESCRIPTION @@ -195,16 +194,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 diff --git a/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..638a131b09 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md @@ -0,0 +1,732 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy +applicable: Microsoft Teams +title: New-CsTeamsCallingPolicy +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: alejandramu +--- + +# New-CsTeamsCallingPolicy + +## SYNOPSIS +Use this cmdlet to create a new instance of a Teams Calling Policy. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsCallingPolicy [-Identity] + [-AIInterpreter ] + [-AllowCallForwardingToPhone ] + [-AllowCallForwardingToUser ] + [-AllowCallGroups ] + [-AllowCallRedirect ] + [-AllowCloudRecordingForCalls ] + [-AllowDelegation ] + [-AllowPrivateCalling ] + [-AllowSIPDevicesCalling ] + [-AllowTranscriptionForCalling ] + [-AllowVoicemail ] + [-AllowWebPSTNCalling ] + [-AutoAnswerEnabledType ] + [-BusyOnBusyEnabledType ] + [-CallingSpendUserLimit ] + [-CallRecordingExpirationDays ] + [-Confirm] + [-Copilot ] + [-Description ] + [-EnableSpendLimits ] + [-EnableWebPstnMediaBypass ] + [-Force] + [-InboundFederatedCallRoutingTreatment ] + [-InboundPstnCallRoutingTreatment ] + [-LiveCaptionsEnabledTypeForCalling ] + [-MusicOnHoldEnabledType ] + [-PopoutAppPathForIncomingPstnCalls ] + [-PopoutForIncomingPstnCalls ] + [-PreventTollBypass ] + [-SpamFilteringEnabledType ] + [-VoiceSimulationInInterpreter ] + [-RealTimeText ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to create new policy instances. + +## EXAMPLES + +### Example 1 +``` +PS C:\> New-CsTeamsCallingPolicy -Identity Sales -AllowPrivateCalling $false +``` + +The cmdlet create the policy instance Sales and sets the value of the parameter AllowPrivateCalling to False. The rest of the parameters are set to the corresponding +values in the Global policy instance. + +## PARAMETERS + +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToPhone +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToUser +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallGroups +Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallRedirect +Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. + +Valid options are: +- Enabled: Enables the user to redirect an incoming call. +- Disabled: The user is not enabled to redirect an incoming call. + +- UserOverride: This option is not available for use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecordingForCalls +Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDelegation +Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateCalling +Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. +If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSIPDevicesCalling +Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscriptionForCalling +Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVoicemail +Enables inbound calls to be routed to voicemail. + +Valid options are: + +- AlwaysEnabled: Calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user. +- AlwaysDisabled: Calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams. +- UserOverride: Calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebPSTNCalling +Allows PSTN calling from the Team web client. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAnswerEnabledType +Setting this parameter allows you to enable or disable auto-answer for incoming meeting invites on Teams Phones. This setting applies only to incoming meeting invites and does not include support for other call types. + +Valid options are: + +- Enabled: Auto-answer is enabled. +- Disabled: Auto-answer is disabled. This is the default setting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BusyOnBusyEnabledType +Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. + +Valid options are: + +- Enabled: New or incoming calls will be rejected with a busy signal. +- Unanswered: The user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. +- Disabled: New or incoming calls will be presented to the user. +- UserOverride: Users can set their busy options directly from call settings in Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallingSpendUserLimit +The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. + +Possible values: any positive integer + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallRecordingExpirationDays +Sets the expiration of the recorded 1:1 calls. Default is 60 days. + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. + +Valid options are: +- Enabled: Copilot can work with or without transcription during calls. This is the default value. +- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. +- Disabled: Copilot is disabled for calls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpendLimits +This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. + +Possible values: + +- True +- False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWebPstnMediaBypass +Determines if MediaBypass is enabled for PSTN calls on specified Web platforms. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundFederatedCallRoutingTreatment +Setting this parameter lets you control how inbound federated calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound federated call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. + +- Voicemail: The inbound federated call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPstnCallRoutingTreatment +Setting this parameter lets you control how inbound PSTN calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound PSTN call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. +- Voicemail: The inbound PSTN call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. +- UserOverride: For now, setting the value to UserOverride is the same as RegularIncoming. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledTypeForCalling +Determines whether real-time captions are available for the user in Teams calls. + +Valid options are: + +- DisabledUserOverride: Allows the user to turn on live captions. +- Disabled: Prohibits the user from turning on live captions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldEnabledType +Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. + +Valid options are: + +- Enabled: Music on hold is enabled. This is the default. +- Disabled: Music on hold is disabled. +- UserOverride: For now, setting the value to UserOverride is the same as Enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutAppPathForIncomingPstnCalls +Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: "" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutForIncomingPstnCalls +Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventTollBypass +Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. + +> [!NOTE] +> Do not set this parameter to True for Calling Plan or Operator Connect users as it will prevent successful call routing. This setting only works with Direct Routing which is configured to handle location-based routing restrictions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamFilteringEnabledType +Determines Spam filtering mode. + +Possible values: + +- Enabled: Spam Filtering is fully enabled. Both Basic and Captcha Interactive Voice Response (IVR) checks are performed. In case the call is considered spam, the user will get a "Spam Likely" notification in Teams. +- Disabled: Spam Filtering is completely disabled. No checks are performed. A "Spam Likely" notification will not appear. +- EnabledWithoutIVR: Spam Filtering is partially enabled. Captcha IVR checks are disabled. A "Spam Likely" notification will appear. A call might get dropped if it gets a high score from Basic checks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +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: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md similarity index 64% rename from skype/skype-ps/skype/New-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md index ea4b850019..fd19f2ca12 100644 --- a/skype/skype-ps/skype/New-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md @@ -1,13 +1,9 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamschannelspolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy +applicable: Microsoft Teams title: New-CsTeamsChannelsPolicy schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # New-CsTeamsChannelsPolicy @@ -19,9 +15,9 @@ The CsTeamsChannelsPolicy allows you to manage features related to the Teams & C ## SYNTAX ``` New-CsTeamsChannelsPolicy [-Tenant ] [-AllowOrgWideTeamCreation ] - [-AllowPrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] - [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] - [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] + [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] + [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] [-ThreadedChannelCreation ] + [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [-Description ] [] ``` ## DESCRIPTION @@ -33,14 +29,14 @@ This cmdlet allows you to create new policies of this type, which can later be a ### Example 1 ```powershell -PS C:\> New-CsTeamsChannelsPolicy -Identity StudentPolicy -AllowPrivateTeamDiscovery $false +PS C:\> New-CsTeamsChannelsPolicy -Identity StudentPolicy -EnablePrivateTeamDiscovery $false ``` This example shows creating a new policy with name "StudentPolicy" where Private Team Discovery is disabled. ## PARAMETERS -### -AllowPrivateTeamDiscovery +### -EnablePrivateTeamDiscovery Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml @@ -160,7 +156,7 @@ Accept wildcard characters: False ``` ### -AllowChannelSharingToExternalUser -Owners of a shared channel can invite external users to join the channel if Azure AD external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](/microsoftteams/teams-policies). +Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -190,7 +186,7 @@ Accept wildcard characters: False ``` ### -AllowUserToParticipateInExternalSharedChannel -Users and teams can be invited to external shared channels if Azure AD external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](/microsoftteams/teams-policies). +Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -204,15 +200,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThreadedChannelCreation +This setting enables/disables Threaded Channel creation and editing. + +Possible Values: +- Enabled: Users are allowed to create and edit Threaded Channels. +- Disabled: Users are not allowed to create and edit Threaded Channels. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Specifies the description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -221,10 +249,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Set-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamschannelspolicy) +[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamschannelspolicy) +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md similarity index 90% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md index e2ac848e53..a08b36dfb9 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md @@ -1,441 +1,443 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication -applicable: Skype for Business Online -title: New-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# New-CsTeamsComplianceRecordingApplication - -## SYNOPSIS -Creates a new association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] - [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] - [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] - [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] - [-Priority ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsComplianceRecordingApplication [-Tenant ] -Parent -Id - [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] - [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] - [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] - [-Priority ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Policy-based recording applications are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. - -Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. - -Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -Once the association is done, the Identity of these application instances becomes \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. -Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -``` - -The command shown in Example 1 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -### Example 2 -```powershell -PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -``` - -The command shown in Example 2 is a variation of Example 1. -It also creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy, but it does this by using the Parent and Id parameters instead of the Identity parameter. - -### Example 3 -```powershell -PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false -``` - -The command shown in Example 3 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is deemed optional for meetings but mandatory for calls. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. - -### Example 4 -```powershell -PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeCallEstablishment $false -RequiredDuringCall $false -``` - -The command shown in Example 4 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is deemed optional for calls but mandatory for meetings. -Please refer to the documentation of the RequiredBeforeCallEstablishment and RequiredDuringCall parameters for more information. - -### Example 5 -```powershell -PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -ConcurrentInvitationCount 2 -``` - -The command shown in Example 5 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is made resilient by specifying that two invites must be sent to the same application for the same call or meeting. -Please refer to the documentation of the ConcurrentInvitationCount parameter for more information. - -### Example 6 -```powershell -PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') -``` - -The command shown in Example 6 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is made resilient by pairing it with another application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. -Separate invites are sent to the paired applications for the same call or meeting. -Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. - -## PARAMETERS - -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. - -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. -For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. -For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. - -If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. -The meeting will still continue for users who are in the meeting. - -If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredDuringMeeting -Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. - -If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. -The meeting will still continue for users who are in the meeting. - -If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredBeforeCallEstablishment -Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. - -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredDuringCall -Indicates whether the policy-based recording application must be in the call while the call is active. - -If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. - -In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplianceRecordingPairedApplications -Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. - -```yaml -Type: ComplianceRecordingPairedApplication[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. - -All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. -So this parameter does not affect the order of invitations to the applications, or any other routing. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: New-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# New-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Creates a new association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] + [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] + [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] + [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] + [-Priority ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsComplianceRecordingApplication [-Tenant ] -Parent -Id + [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] + [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] + [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] + [-Priority ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' +``` + +The command shown in Example 1 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +### Example 2 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' +``` + +The command shown in Example 2 is a variation of Example 1. +It also creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy, but it does this by using the Parent and Id parameters instead of the Identity parameter. + +### Example 3 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false +``` + +The command shown in Example 3 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is deemed optional for meetings but mandatory for calls. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. + +### Example 4 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeCallEstablishment $false -RequiredDuringCall $false +``` + +The command shown in Example 4 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is deemed optional for calls but mandatory for meetings. +Please refer to the documentation of the RequiredBeforeCallEstablishment and RequiredDuringCall parameters for more information. + +### Example 5 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -ConcurrentInvitationCount 2 +``` + +The command shown in Example 5 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by specifying that two invites must be sent to the same application for the same call or meeting. +Please refer to the documentation of the ConcurrentInvitationCount parameter for more information. + +### Example 6 +```powershell +PS C:\> New-CsTeamsComplianceRecordingApplication -Parent 'Tag:ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +The command shown in Example 6 creates a new association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by pairing it with another application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +Separate invites are sent to the paired applications for the same call or meeting. +Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. + +## PARAMETERS + +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. + +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent +The Identity of the Teams recording policy that this application instance of a policy-based recording application is associated with. +For example, the Parent of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy\", which indicates that the application instance is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. +For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. + +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. + +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. + +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. + +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. + +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. + +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. + +All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. +So this parameter does not affect the order of invitations to the applications, or any other routing. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPairedApplication.md b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md similarity index 73% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingPairedApplication.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md index 31fd178e11..d444f6ae79 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPairedApplication.md +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md @@ -1,107 +1,109 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication -applicable: Skype for Business Online -title: New-CsTeamsComplianceRecordingPairedApplication -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# New-CsTeamsComplianceRecordingPairedApplication - -## SYNOPSIS -Creates a new association between multiple application instances of policy-based recording applications to achieve application resiliency in automatic policy-based recording scenarios. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -``` -New-CsTeamsComplianceRecordingPairedApplication -Id - [] -``` - -## DESCRIPTION -Policy-based recording applications are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. - -Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application, to determine if application resiliency is needed for your workflows, and how best to achieve application resiliency. -Please also refer to the documentation of CsTeamsComplianceRecordingApplication cmdlets for further information. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144' -``` - -The command shown in Example 1 creates an in-memory instance of an application instance of a policy-based recording application that can be associated with other such application instances to achieve application resiliency. - -Note that this cmdlet is only used in conjunction with New-CsTeamsComplianceRecordingApplication and Set-CsTeamsComplianceRecordingApplication to create associations between multiple application instances of policy-based recording applications. -Please refer to the documentation of CsTeamsComplianceRecordingApplication cmdlets for examples and further information. - -## PARAMETERS - -### -Id -The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. -For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. - -```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 - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication +applicable: Microsoft Teams +title: New-CsTeamsComplianceRecordingPairedApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# New-CsTeamsComplianceRecordingPairedApplication + +## SYNOPSIS +Creates a new association between multiple application instances of policy-based recording applications to achieve application resiliency in automatic policy-based recording scenarios. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +``` +New-CsTeamsComplianceRecordingPairedApplication -Id + [] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application, to determine if application resiliency is needed for your workflows, and how best to achieve application resiliency. +Please also refer to the documentation of CsTeamsComplianceRecordingApplication cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144' +``` + +The command shown in Example 1 creates an in-memory instance of an application instance of a policy-based recording application that can be associated with other such application instances to achieve application resiliency. + +Note that this cmdlet is only used in conjunction with New-CsTeamsComplianceRecordingApplication and Set-CsTeamsComplianceRecordingApplication to create associations between multiple application instances of policy-based recording applications. +Please refer to the documentation of CsTeamsComplianceRecordingApplication cmdlets for examples and further information. + +## PARAMETERS + +### -Id +The ObjectId of the application instance of a policy-based recording application as exposed by the Get-CsOnlineApplicationInstance cmdlet. +For example, the Id of an application instance can be \"39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance has ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. + +```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 + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) diff --git a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md similarity index 76% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md index 40d97cca87..e1caae78f9 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md @@ -1,284 +1,346 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy -applicable: Skype for Business Online -title: New-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# New-CsTeamsComplianceRecordingPolicy - -## SYNOPSIS -Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -``` -New-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] - [-Enabled ] [-WarnUserOnRemoval ] [-DisableComplianceRecordingAudioNotificationForCalls ] [-Description ] - [-ComplianceRecordingApplications ] - [-InMemory] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams recording policies are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. - -Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. -Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. -The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. -Existing calls and meetings are unaffected. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899') -``` - -The command shown in Example 1 creates a new per-user Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. -This policy is assigned a single application instance of a policy-based recording application: d93fefc7-93cc-4d44-9a5d-344b0fff2899, which is the ObjectId of the application instance as obtained from the Get-CsOnlineApplicationInstance cmdlet. - -Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by that application instance. Existing calls and meetings are unaffected. - -### Example 2 -```powershell -PS C:\> New-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899'), @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') -``` - -Example 2 is a variation of Example 1. -In this case, the Teams recording policy is assigned two application instances of policy-based recording applications. - -Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by both those application instances. Existing calls and meetings are unaffected. - -## PARAMETERS - -### -Identity -Unique identifier to be assigned to the new Teams recording policy. - -Use the "Global" Identity if you wish to assign this policy to the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Controls whether this Teams recording policy is active or not. - -Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnUserOnRemoval -This parameter is reserved for future use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplianceRecordingApplications -A list of application instances of policy-based recording applications to assign to this policy. -The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -```yaml -Type: ComplianceRecordingApplication[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: New-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +--- + +# New-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Creates a new Teams recording policy for governing automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +```powershell +New-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] + [-Enabled ] [-WarnUserOnRemoval ] [-DisableComplianceRecordingAudioNotificationForCalls ] + [-RecordReroutedCalls ] [-Description ] + [-ComplianceRecordingApplications ] [-CustomBanner ] + [-CustomPromptsEnabled ] [-CustomPromptsPackageId ] + [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899') +``` + +The command shown in Example 1 creates a new per-user Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. +This policy is assigned a single application instance of a policy-based recording application: d93fefc7-93cc-4d44-9a5d-344b0fff2899, which is the ObjectId of the application instance as obtained from the Get-CsOnlineApplicationInstance cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by that application instance. Existing calls and meetings are unaffected. + +### Example 2 +```powershell +PS C:\> New-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899'), @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +Example 2 is a variation of Example 1. +In this case, the Teams recording policy is assigned two application instances of policy-based recording applications. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by both those application instances. Existing calls and meetings are unaffected. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomBanner +References the Custom Banner text in the storage. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WarnUserOnRemoval +This parameter is reserved for future use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +```yaml +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPromptsEnabled +Indicates whether compliance recording custom prompts feature is enabled for this tenant / user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomPromptsPackageId +Reference to custom prompts package. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md similarity index 93% rename from skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md rename to teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md index e392f63c1a..247ea3b3a6 100644 --- a/skype/skype-ps/skype/New-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCortanaPolicy.md @@ -1,234 +1,234 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscortanapolicy -applicable: Skype for Business Online -title: New-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta -author: akshbhat -ms.author: akshbhat -ms.reviewer: ---- - -# New-CsTeamsCortanaPolicy - -## SYNOPSIS -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. - -## SYNTAX - -``` -New-CsTeamsCortanaPolicy [-Tenant ] [-Description ] [-CortanaVoiceInvocationMode ] - [-AllowCortanaVoiceInvocation ] [-AllowCortanaAmbientListening ] - [-AllowCortanaInContextSuggestions ] [-Identity] [-InMemory] [-Force] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - -* Disabled - Cortana voice assistant is disabled -* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation -* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported - -This cmdlet creates a new Teams Cortana policy. Custom policies can then be assigned to users using the Grant-CsTeamsCortanaPolicy cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -CortanaVoiceInvocationMode PushToTalkUserOverride -``` - -In this example, a new Teams Cortana Policy is created. Cortana voice invocation mode is set to 'push to talk' i.e. Cortana in Teams can be invoked by tapping on the Cortana mic button only. Wake word ("Hey Cortana") invocation is not allowed. - -## PARAMETERS - -### -AllowCortanaAmbientListening -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCortanaInContextSuggestions -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCortanaVoiceInvocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CortanaVoiceInvocationMode -The value of this field indicates if Cortana is enabled and mode of invocation. -* Disabled - Cortana voice assistant is turned off and cannot be used. -* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation -* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of your policy to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for Teams cortana policy you're creating. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: New-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +``` +New-CsTeamsCortanaPolicy [-Tenant ] [-Description ] [-CortanaVoiceInvocationMode ] + [-AllowCortanaVoiceInvocation ] [-AllowCortanaAmbientListening ] + [-AllowCortanaInContextSuggestions ] [-Identity] [-InMemory] [-Force] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +This cmdlet creates a new Teams Cortana policy. Custom policies can then be assigned to users using the Grant-CsTeamsCortanaPolicy cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -CortanaVoiceInvocationMode PushToTalkUserOverride +``` + +In this example, a new Teams Cortana Policy is created. Cortana voice invocation mode is set to 'push to talk' i.e. Cortana in Teams can be invoked by tapping on the Cortana mic button only. Wake word ("Hey Cortana") invocation is not allowed. + +## PARAMETERS + +### -AllowCortanaAmbientListening +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaInContextSuggestions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaVoiceInvocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CortanaVoiceInvocationMode +The value of this field indicates if Cortana is enabled and mode of invocation. +* Disabled - Cortana voice assistant is turned off and cannot be used. +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of your policy to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for Teams cortana policy you're creating. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/New-CsTeamsCustomBannerText b/teams/teams-ps/teams/New-CsTeamsCustomBannerText new file mode 100644 index 0000000000..af23fbf760 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCustomBannerText @@ -0,0 +1,95 @@ +--- +Module Name: MicrosoftTeams +title: New-CsTeamsCustomBannerText +author: saleens7 +ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsCustomBannerText +schema: 2.0.0 +--- + +# New-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsCustomBannerText [[-Id] ] [] +``` + +## DESCRIPTION + +Creates a single instance of a custom banner text. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsCustomBannerText -Identity CustomText +``` + +Creates an instance of TeamsCustomBannerText with the name CustomText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that the tenant admin would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that the tenant admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..4ed97c99b6 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md @@ -0,0 +1,95 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext +title: New-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# New-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsCustomBannerText [[-Id] ] [] +``` + +## DESCRIPTION + +Creates a single instance of a custom banner text. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" +``` + +This example creates an instance of TeamsCustomBannerText with the name CustomText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that the global admin would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that the global admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md similarity index 67% rename from skype/skype-ps/skype/New-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md index 82d0f45fc2..0cc06eb366 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsemergencycallroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy applicable: Microsoft Teams title: New-CsTeamsEmergencyCallRoutingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manger: roykuntz ms.reviewer: chenc, vaddank schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet creates a new Teams Emergency Call Routing policy with one or more e ## SYNTAX ``` -New-CsTeamsEmergencyCallRoutingPolicy [-Identity] [-AllowEnhancedEmergencyServices ] +New-CsTeamsEmergencyCallRoutingPolicy [-Identity] [-AllowEnhancedEmergencyServices ] [-Description ] [-EmergencyNumbers ] [-WhatIf] [-Confirm] [] ``` @@ -30,11 +30,19 @@ This cmdlet creates a new Teams Emergency Call Routing policy with one or more e ### Example 1 ```powershell $en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "911" -EmergencyDialMask "933" -OnlinePSTNUsage "USE911" -New-CsTeamsEmergencyCallRoutingPolicy -Identity "testecrp" -EmergencyNumbers @{add=$en1} -AllowEnhancedEmergencyServices:$true -Description "test" +New-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{add=$en1} -AllowEnhancedEmergencyServices:$true -Description "test" ``` This example first creates a new Teams emergency number object and then creates a Teams Emergency Call Routing policy with this emergency number object. Note that the OnlinePSTNUsage specified in the first command must previously exist. Note that the resulting object from the New-CsTeamsEmergencyNumber only exists in memory, so you must apply it to a policy to be used. +Note that {@add=....} will try to append a new emergency number to the values taken from the global instance. + +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "911" -EmergencyDialMask "933" -OnlinePSTNUsage "USE911" +New-CsTeamsEmergencyCallRoutingPolicy -Identity "testecrp" -EmergencyNumbers $en1 -AllowEnhancedEmergencyServices:$true -Description "test" +``` +This example overrides the global emergency numbers from the global instance. ## PARAMETERS @@ -84,7 +92,7 @@ Accept wildcard characters: False ``` ### -EmergencyNumbers -One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](new-csteamsemergencynumber.md) cmdlet. +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. ```yaml Type: Object @@ -130,7 +138,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -139,14 +147,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) + +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md new file mode 100644 index 0000000000..693ea5b9cd --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -0,0 +1,116 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification +applicable: Microsoft Teams +title: New-CsTeamsEmergencyCallingExtendedNotification +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyCallingExtendedNotification + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [-NotificationGroup ] + [-NotificationDialOutNumber ] [-NotificationMode ] [] +``` + +## DESCRIPTION +This cmdlet supports creating specific emergency calling notification settings per emergency phone number. It is used with TeamsEmergencyCallingPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +``` + +Creates an extended emergency calling notification for the emergency phone number 911 and stores it in the variable $en1. The variable should be added afterward to a TeamsEmergencyCallingPolicy instance. + +## PARAMETERS + +### -EmergencyDialString +Specifies the emergency phone number. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 entries consisting of users and/or groups can be added to the NotificationGroup. The total number of users notified cannot exceed 50. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. + +```yaml +Type: Microsoft.Rtc.Management.WritableConfig.Policy.Teams.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..60f9db0fb7 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy +applicable: Microsoft Teams +title: New-CsTeamsEmergencyCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# New-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS + +## SYNTAX + +``` +New-CsTeamsEmergencyCallingPolicy [-Identity] [-ExtendedNotifications ] + [-NotificationGroup ] [-NotificationDialOutNumber ] [-ExternalLocationLookupMode ] + [-NotificationMode ] [-EnhancedEmergencyServiceDisclaimer ] [-Description ] [-Force] [-WhatIf] [-Confirm] [] + ``` + +## DESCRIPTION +This cmdlet creates a new Teams Emergency Calling policy. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Emergency calling policy Example 1 +In the following example, ECP1, an emergency calling policy with identify ECP1 is configured with full security desk configuration. Extended notifications for the test emergency number, 933, are set to null. +**ECP1** +
    +
  • Notification group: alert@contoso.com
    • +
  • Notification Dial Out Number - 14255551234
    • +
  • Notification Mode - Conferenced in and are unmuted
    • +
  • External Lookup Mode - On
    • +
+ +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "933" +New-CsTeamsEmergencyCallingPolicy -Identity ECP1 -Description "Test ECP1" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode ConferenceUnMuted -ExternalLocationLookupMode Enabled -ExtendedNotifications @{add=$en1} +``` + +### Emergency calling policy Example 2 +In the following example, ECP2, an emergency calling policy with identify ECP2 is configured with both 911 and 933 in the extended notification settings. Extended notifications for the test emergency number 911 are set to notify two groups separated by ";" and for 933 are set to null. +**ECP2** +
    +
  • Notification group: null
    • +
  • Notification Dial Out Number - null
    • +
  • Notification Mode - null
    • +
  • External Lookup Mode - On
    • +
+ +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert@contoso.com;567@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode ConferenceUnMuted +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "933" +New-CsTeamsEmergencyCallingPolicy -Identity ECP2 -Description "Test ECP2" -ExternalLocationLookupMode Enabled -ExtendedNotifications @{add=$en1,$en2} +``` + +## PARAMETERS + +### -Identity + The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter describes the Teams Emergency Calling policy - what it is for, what type of user it applies to and any other information that helps to identify the purpose of this policy. Maximum characters: 512. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnhancedEmergencyServiceDisclaimer +Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. The disclaimer can be up to 350 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedNotifications + +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. + +If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. + +```yaml +Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalLocationLookupMode +Enable ExternalLocationLookupMode. This mode allow users to set Emergency addresses for remote locations. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call via Teams chat. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and a maximum of 50 users in total can be notified. Both UPN and SMTP address are accepted when adding users directly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. +Possible values are NotificationOnly, ConferenceMuted, and ConferenceUnMuted. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) + +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) diff --git a/skype/skype-ps/skype/New-CsTeamsEmergencyNumber.md b/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md similarity index 77% rename from skype/skype-ps/skype/New-CsTeamsEmergencyNumber.md rename to teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md index caa533f9c4..9d89a4ced3 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyNumber.md +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyNumber.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsemergencynumber +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber applicable: Microsoft Teams title: New-CsTeamsEmergencyNumber -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc, pthota schema: 2.0.0 @@ -28,14 +28,14 @@ New-CsTeamsEmergencyNumber [-EmergencyDialString ] [-EmergencyDialMask < ### Example 1 ```powershell -PS C:> New-CsTeamsEmergencyNumber -EmergencyDialString 911 -EmergencyDialMask 933 -OnlinePSTNUsage "US911" +PS C:\> New-CsTeamsEmergencyNumber -EmergencyDialString 911 -EmergencyDialMask 933 -OnlinePSTNUsage "US911" ``` Create a new Teams emergency number - + ### Example 2 ```powershell -PS C:> New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "117;897" -OnlinePSTNUsage "EU112" +PS C:\> New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "117;897" -OnlinePSTNUsage "EU112" ``` Create a new Teams emergency number with multiple emergency dial masks. @@ -88,7 +88,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -97,10 +97,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md index 00bd499120..94d8089d7a 100644 --- a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy title: New-CsTeamsEnhancedEncryptionPolicy -author: xinawang -ms.author: xinawang +author: serdarsoysal +ms.author: serdars manager: mdress schema: 2.0.0 --- @@ -17,14 +17,14 @@ Use this cmdlet to create a new Teams enhanced encryption policy. ## SYNTAX ``` -New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] +New-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] [[-Identity] ] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Use this cmdlet to create a new Teams enhanced encryption policy. -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. ## EXAMPLES @@ -37,7 +37,7 @@ Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTea ### EXAMPLE 2 ```PowerShell -PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride +PS C:\> New-CsTeamsEnhancedEncryptionPolicy -Identity ContosoPartnerTeamsEnhancedEncryptionPolicy -CallingEndtoEndEncryptionEnabledType DisabledUserOverride -MeetingEndToEndEncryption DisabledUserOverride ``` Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTeamsEnhancedEncryptionPolicy and applies the provided values to its settings. @@ -47,7 +47,6 @@ Creates a new instance of TeamsEnhancedEncryptionPolicy called ContosoPartnerTea ### -Description Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - For example, the Description might include information about the users the policy should be assigned to. ```yaml @@ -63,7 +62,22 @@ Accept wildcard characters: False ``` ### -CallingEndtoEndEncryptionEnabledType -Determines whether End-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on End-to-end encrypted calls. Set this to Disabled to prohibit. +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. ```yaml Type: Enum @@ -80,7 +94,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams enhanced encryption policy. - ```yaml Type: XdsIdentity Parameter Sets: (All) @@ -157,21 +170,20 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) - -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) -[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) -[Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..778df29878 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md @@ -0,0 +1,391 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamseventspolicy +title: New-CsTeamsEventsPolicy +schema: 2.0.0 +ms.date: 04/23/2025 +--- + +# New-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to create a new TeamsEventsPolicy instance and set its properties. Note that this policy is currently still in preview. + +## SYNTAX + +```powershell +New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-AllowEmailEditing ] [-Description ] +[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] +[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] +[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisablePublicWebinars -AllowWebinars Enabled -EventAccessType EveryoneInCompanyExcludingGuests +``` + +The command shown in Example 1 creates a new per-user Teams Events policy with the Identity DisablePublicWebinars. This policy disables a user from creating public webinars. + +### Example 2 +```powershell +PS C:\> New-CsTeamsEventsPolicy -Identity DisableWebinars -AllowWebinars Disabled +``` + +The command shown in Example 2 creates a new per-user Teams Events policy with the Identity DisableWebinars. This policy disables a user from creating webinars. + +## PARAMETERS + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town hall. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType +This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. + +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + + - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting governs which types of town halls can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting governs which types of webinars can have their recordings published. + +Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs the access to the integrations tab in the event creation workflow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallChatExperience +This setting governs if the user can enable the Comment Stream chat experience for Townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch does not work with this cmdlet. +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md similarity index 82% rename from skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md index 6ffc522269..97eb4b84ce 100644 --- a/skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md @@ -1,13 +1,9 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsfeedbackpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfeedbackpolicy +applicable: Microsoft Teams title: New-CsTeamsFeedbackPolicy schema: 2.0.0 -manager: bulenteg -ms.author: tomkau -author: tomkau -ms.reviewer: --- # New-CsTeamsFeedbackPolicy @@ -17,14 +13,14 @@ Use this cmdlet to control whether users in your organization can send feedback ## SYNTAX -``` +```powershell New-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-InMemory] -[-AllowEmailCollection ] [-AllowLogCollection ] [-AllowScreenshotCollection ] - [-UserInitiatedMode ] [-ReceiveSurveysMode ] [-Force] +[-AllowEmailCollection ] [-AllowLogCollection ] [-AllowScreenshotCollection ] [-EnableFeatureSuggestions ] + [-UserInitiatedMode ] [-ReceiveSurveysMode ] [-Force] [] ``` ## DESCRIPTION -Use this cmdlet to control whether users in your organization can send feedback about Teams to Microsoft through Give feedback and whether they receive the survey. By default, all users in your organization are automatically assigned the global (Org-wide default) policy and the Give feedback feature and survey are enabled in the policy. The exception is Teams for Education, where the features are enabled for teachers and disabled for students. For more information, visit [Manage feedback policies in Microsoft Teams](https://docs.microsoft.com/microsoftteams/manage-feedback-policies-in-teams). +Use this cmdlet to control whether users in your organization can send feedback about Teams to Microsoft through Give feedback and whether they receive the survey. By default, all users in your organization are automatically assigned the global (Org-wide default) policy and the Give feedback feature and survey are enabled in the policy. The exception is Teams for Education, where the features are enabled for teachers and disabled for students. For more information, visit [Manage feedback policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-feedback-policies-in-teams). ## EXAMPLES @@ -194,6 +190,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableFeatureSuggestions + This setting will enable Tenant Admins to hide or show the Teams menu item “Help | Suggest a Feature”. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +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. @@ -210,6 +221,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -217,6 +231,7 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..dca829ac76 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsFilesPolicy.md @@ -0,0 +1,168 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy +title: New-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# New-CsTeamsFilesPolicy + +## SYNOPSIS +Creates a new teams files policy. +teams files policies determine whether or not files entry points to sharepoint enabled for a user. +The policies also specify third party app id to allow file storage(eg. Box). + +## SYNTAX + +```powershell +New-CsTeamsFilesPolicy [-NativeFileEntryPoints ] [-SPChannelFilesTab ] + [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-Identity] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +If your organization chooses a third-party for content storage, you can turn off the NativeFileEntryPoints parameter in the Teams Files policy. This parameter is enabled by default, which shows option to attach OneDrive / SharePoint content from Teams chats or channels. When this parameter is disabled, users won't see access points for OneDrive and SharePoint in Teams. Please note that OneDrive app in the left navigation pane in Teams isn't affected by this policy. +Teams administrators would be able to create a customized teams files policy to match the organization's requirements. + +## EXAMPLES + +### Example 1 +```powershell +New-CsTeamsFilesPolicy -Identity "CustomTeamsFilesPolicy" -NativeFileEntryPoints Disabled/Enabled +``` + +The command shown in Example 1 creates a per-user teams files policy CustomTeamsFilesPolicy with NativeFileEntryPoints set to Disabled/Enabled and other fields set to tenant level global value. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +``` + +### -DefaultFileUploadAppId +This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPChannelFilesTab + +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) + diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md new file mode 100644 index 0000000000..afae69de7e --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -0,0 +1,72 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsHiddenMeetingTemplate +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsHiddenMeetingTemplate +schema: 2.0.0 +--- + +# New-CsTeamsHiddenMeetingTemplate + +## SYNOPSIS +This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. + +## SYNTAX + +```powershell +New-CsTeamsHiddenMeetingTemplate -Id [] +``` + +## DESCRIPTION + +Creates an object that can be supplied as `HiddenMeetingTemplate` to the [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) and [Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) cmdlets. + +## EXAMPLES + +### Example 1 - Creating a new hidden meeting template + +Creates a new hidden meeting template object: + +```powershell +PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +``` + +Creates a new HiddenMeetingTemplate object with the given template ID. + +For more examples of how this can be used, see the examples for [New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy). + +## PARAMETERS + +### -Id + +ID of the meeting template to hide. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +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-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md b/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md new file mode 100644 index 0000000000..5df0f7b450 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md @@ -0,0 +1,69 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate +title: New-CsTeamsHiddenTemplate +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# New-CsTeamsHiddenTemplate + +## SYNOPSIS +This cmdlet is used to create a `HiddenTemplate` object for use with the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. + +## SYNTAX + +``` +New-CsTeamsHiddenTemplate -Id [] +``` + +## DESCRIPTION +Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) and [Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) cmdlets. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +``` + +Creates a new hidden Teams template object. For more examples of how this can be used, see the examples for [New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy). + +## PARAMETERS + +### -Id +ID of the Teams template to hide. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### HiddenTemplate.Cmdlets.HiddenTemplate + +## NOTES + +## RELATED LINKS +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md similarity index 81% rename from skype/skype-ps/skype/New-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md index 58edc28676..93cdfa7a78 100644 --- a/skype/skype-ps/skype/New-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsIPPhonePolicy.md @@ -1,249 +1,261 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsipphonepolicy -applicable: Skype for Business Online -title: New-CsTeamsIPPhonePolicy -author: tonywoodruff -ms.author: anwoodru -ms.reviewer: kponnus -manager: sandrao -schema: 2.0.0 ---- - -# New-CsTeamsIPPhonePolicy - -## SYNOPSIS - -New-CsTeamsIPPhonePolicy allows you to create a policy to manage features related to Teams phone experiences. Teams phone policies determine the features that are available to users. - -## SYNTAX - -``` -New-CsTeamsIPPhonePolicy [-AllowHomeScreen ] [-AllowBetterTogether ] [-Description ] [-HotDeskingIdleTimeoutInMinutes ] - - [-AllowHotDesking ] [[-Identity] ] [-Tenant ] [-InMemory] [-SignInMode ] - - [-WhatIf] [-Confirm] [-Force] [-SearchOnCommonAreaPhoneMode ] -``` - -## DESCRIPTION - -The New-CsTeamsIPPhonePolicy cmdlet allows you to create a policy to manage features related to Teams phone experiences assigned to a user account used to sign into a Teams phone. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin -``` -This example shows a new policy being created called "CommonAreaPhone" setting the SignInMode as "CommonAreaPhoneSignIn". - -## PARAMETERS - -### -AllowBetterTogether -Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. -Possible values this parameter can take: - -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowHomeScreen -Determines whether the Home Screen feature of the Teams IP Phones is enabled. -Possible values this parameter can take: - -- Enabled -- EnabledUserOverride -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: EnabledUserOverride -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowHotDesking -Determines whether hot desking mode is enabled. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Free form text that can be used by administrators as desired. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HotDeskingIdleTimeoutInMinutes -Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The identity of the policy that you want to create. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchOnCommonAreaPhoneMode -Determines whether a user can search the Global Address List in Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInMode -Determines the sign in mode for the device when signing in to Teams. -Possible Values: -- 'UserSignIn: Enables the individual user's Teams experience on the phone' -- 'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone' -- 'MeetingSignIn: Enables the meeting/conference room experience on the phone' - -```yaml -Type: String - -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsipphonepolicy +applicable: Microsoft Teams +title: New-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# New-CsTeamsIPPhonePolicy + +## SYNOPSIS + +New-CsTeamsIPPhonePolicy allows you to create a policy to manage features related to Teams phone experiences. Teams phone policies determine the features that are available to users. + +## SYNTAX + +``` +New-CsTeamsIPPhonePolicy [[-Identity] ] + [-AllowBetterTogether ] + [-AllowHomeScreen ] + [-AllowHotDesking ] + [-Confirm] + [-Description ] + [-Force] + [-HotDeskingIdleTimeoutInMinutes ] + [-InMemory] + [-SearchOnCommonAreaPhoneMode ] + [-SignInMode ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +The New-CsTeamsIPPhonePolicy cmdlet allows you to create a policy to manage features related to Teams phone experiences assigned to a user account used to sign into a Teams phone. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin +``` +This example shows a new policy being created called "CommonAreaPhone" setting the SignInMode as "CommonAreaPhoneSignIn". + +## PARAMETERS + +### -Identity +The identity of the policy that you want to create. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBetterTogether +Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. +Possible values this parameter can take: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHomeScreen +Determines whether the Home Screen feature of the Teams IP Phones is enabled. +Possible values this parameter can take: + +- Enabled +- EnabledUserOverride +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHotDesking +Determines whether hot desking mode is enabled. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free form text that can be used by administrators as desired. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotDeskingIdleTimeoutInMinutes +Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchOnCommonAreaPhoneMode +Determines whether a user can search the Global Address List in Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInMode +Determines the sign in mode for the device when signing in to Teams. +Possible Values: +- 'UserSignIn: Enables the individual user's Teams experience on the phone' +- 'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone' +- 'MeetingSignIn: Enables the meeting/conference room experience on the phone' + +```yaml +Type: String + +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..3f141907b4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: New-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# New-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS +This cmdlet creates a Teams media connectivity policy. + +## SYNTAX + +```powershell +New-CsTeamsMediaConnectivityPolicy -Identity [-DirectConnection ] [] +``` + +## DESCRIPTION +This cmdlet creates a Teams media connectivity policy. If you get an error that the policy already exists, it means that the policy already exists for your tenant. In this case, run Get-CsTeamsMediaConnectivityPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsMediaConnectivityPolicy -Identity Test + +Identity DirectConnection +------------------------- +Tag:Test Enabled +``` +Creates a new Teams media connectivity policy with the specified identity. +The newly created policy with value will be printed on success. + +## PARAMETERS + +### -Identity +Identity of the Teams media connectivity policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectConnection +This setting will enable Tenant Admins to control the Teams media connectivity behavior in Teams for both Meetings and 1:1 calls. If this setting is set to true, a direct media connection between the current user and a remote user is allowed which may improve the meeting quality and reduce the egress bandwidth usage for the customer. If this setting is set to disabled, no direct media connection will be allowed for the current user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) + +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..6a2c7ee7cd --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: New-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# New-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +```powershell +New-CsTeamsMeetingBrandingPolicy + [-MeetingBackgroundImages ] + [-MeetingBrandingThemes ] + [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] + [-EnableNdiAssuranceSlate ] [-NdiAssuranceSlateImages ] [-RequireBackgroundEffect ] + [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet creates a new **TeamsMeetingBrandingPolicy**. +You can only create an empty meeting branding policy with this cmdlet, image upload is not supported. +If you want to upload the images, you should use Teams Admin Center. + +## EXAMPLES + +### Create empty meeting branding policy +```powershell +PS C:\> New-CsTeamsMeetingBrandingPolicy -Identity "test policy" +``` + +In this example, the command will create an empty meeting branding policy with the identity `test policy`. + +## PARAMETERS + +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingBackgroundImages +Enable custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allow organizer to control meeting theme. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity of meeting branding policy that will be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +Image upload is not possible via cmdlets. You should upload background images via Teams Admin Center. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBrandingThemes +*This parameter is reserved for Microsoft internal use only.* +List of meeting branding themes. +Image upload is not possible via cmdlets. You should create meeting themes via Teams Admin Center. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNdiAssuranceSlate +This enables meeting Network Device Interface Assurance Slate branding. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NdiAssuranceSlateImages +Used to specify images that can be used as assurance slates during NDI (Network Device Interface) streaming in Teams meetings. This parameter allows administrators to define a set of images that can be displayed to participants to ensure that the NDI stream is functioning correctly. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.NdiAssuranceSlate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequireBackgroundEffect +This mandates a meeting background for participants. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md similarity index 93% rename from skype/skype-ps/skype/New-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md index 3a4a7236ec..898cfcd848 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsmeetingbroadcastpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: New-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsTeamsMeetingBroadcastPolicy @@ -33,16 +33,15 @@ User-level policy for tenant admin to configure meeting broadcast behavior for t ### Example 1 ```powershell -PS C:\> New-CsTeamsMeetingBroadcastPolicy -Identity Students -AllowBroadcastScheduling $false +PS C:\> New-CsTeamsMeetingBroadcastPolicy -Identity Students -AllowBroadcastScheduling $false ``` Creates a new MeetingBroadcastPolicy with broadcast scheduling disabled, which can then be assigned to individual users using the corresponding grant- command. - ## PARAMETERS ### -AllowBroadcastScheduling -Specifies whether this user can create broadcast events in Teams. This settng impacts broadcasts that use both self-service and external encoder production methods. +Specifies whether this user can create broadcast events in Teams. This setting impacts broadcasts that use both self-service and external encoder production methods. ```yaml Type: Boolean @@ -216,8 +215,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md similarity index 50% rename from skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md index 939573bc0d..8c7b734046 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md @@ -1,42 +1,129 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsmeetingpolicy -applicable: Skype for Business Online +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingpolicy +Module Name: MicrosoftTeams +applicable: Microsoft Teams title: New-CsTeamsMeetingPolicy schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: +ms.reviewer: alejandramu +ms.date: 2/26/2025 --- # New-CsTeamsMeetingPolicy ## SYNOPSIS The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + ## SYNTAX -``` -New-CsTeamsMeetingPolicy [-Tenant ] [-Description ] - [-AllowChannelMeetingScheduling ] [-AllowMeetNow ] [-AllowPrivateMeetNow ] [-AllowIPVideo ] [-IPAudioMode ] [-IPVideoMode ] +```powershell +New-CsTeamsMeetingPolicy [-Identity] + [-AIInterpreter ] [-AllowAnonymousUsersToDialOut ] - [-AllowAnonymousUsersToJoinMeeting ] [-AllowAnonymousUsersToStartMeeting ] + [-AllowAnonymousUsersToJoinMeeting ] + [-AllowAnonymousUsersToStartMeeting ] + [-AllowAnnotations ] + [-AllowAvatarsInGallery ] + [-AllowBreakoutRooms ] + [-AllowCarbonSummary ] + [-AllowCartCaptionsScheduling ] + [-AllowChannelMeetingScheduling ] + [-AllowCloudRecording ] + [-AllowDocumentCollaboration ] + [-AllowedUsersForMeetingContext ] + [-AllowEngagementReport ] + [-AllowExternalNonTrustedMeetingChat ] + [-AllowExternalParticipantGiveRequestControl ] + [-AllowImmersiveView ] + [-AllowIPAudio ] + [-AllowIPVideo ] + [-AllowLocalRecording] + [-AllowMeetingCoach ] + [-AllowMeetNow ] + [-AllowMeetingReactions ] + [-AllowMeetingRegistration ] + [-AllowNDIStreaming ] + [-AllowNetworkConfigurationSettingsLookup ] + [-AllowOrganizersToOverrideLobbySettings ] + [-AllowOutlookAddIn ] + [-AllowPSTNUsersToBypassLobby ] + [-AllowParticipantGiveRequestControl ] + [-AllowPowerPointSharing ] + [-AllowPrivateMeetNow ] + [-AllowPrivateMeetingScheduling ] + [-AllowRecordingStorageOutsideRegion ] + [-AllowScreenContentDigitization ] + [-AllowSharedNotes ] + [-AllowTasksFromTranscript ] + [-AllowTrackingInReport ] + [-AllowTranscription ] + [-AllowUserToJoinExternalMeeting ] + [-AllowWatermarkCustomizationForCameraVideo ] + [-AllowWatermarkCustomizationForScreenSharing ] + [-AllowWatermarkForCameraVideo ] + [-AllowWatermarkForScreenSharing ] + [-AllowWhiteboard ] + [-AllowedStreamingMediaInput ] + [-AnonymousUserAuthenticationMethod ] + [-AttendeeIdentityMasking ] + [-AudibleRecordingNotification ] + [-AutoAdmittedUsers ] + [-AutomaticallyStartCopilot ] [-BlockedAnonymousJoinClientTypes ] - [-AllowPrivateMeetingScheduling ] [-AutoAdmittedUsers ] [-AllowCloudRecording ] - [-AllowOutlookAddIn ] [-AllowPowerPointSharing ] - [-AllowParticipantGiveRequestControl ] [-AllowExternalParticipantGiveRequestControl ] - [-AllowSharedNotes ] [-AllowWhiteboard ] [-AllowTranscription ] [-AllowCartCaptionsScheduling ] - [-MediaBitRateKb ] [-ScreenSharingMode ] [-PreferredMeetingProviderForIslandsMode ] - [-VideoFiltersMode ] [-Identity] [-AllowEngagementReport ] - [-AllowNDIStreaming ] [-DesignatedPresenterRoleMode ] [-AllowPSTNUsersToBypassLobby ] - [-AllowIPAudio ] [-AllowOrganizersToOverrideLobbySettings ] -[-AllowUserToJoinExternalMeeting ] [-EnrollUserOverride ] [-StreamingAttendeeMode ] -[-AllowBreakoutRooms ] [-AllowMeetingReactions ] [-MeetingChatEnabledType ] -[-AllowMeetingRegistration ] [-AllowRecordingStorageOutsideRegion ] [-AllowScreenContentDigitization ] -[-AllowTrackingInReport ] [-LiveCaptionsEnabledType ] [-RecordingStorageMode ] [-RoomAttributeUserOverride ] -[-SpeakerAttributionMode ] [-WhoCanRegister ] [-NewMeetingRecordingExpirationDays ] -[-MeetingInviteLanguages ] [-AllowNetworkConfigurationSettingsLookup ] [-LiveStreamingMode ] -[-InMemory] [-Force] [-WhatIf] [-Confirm] [] + [-CaptchaVerificationForMeetingJoin ] + [-ChannelRecordingDownload ] + [-ConnectToMeetingControls ] + [-Confirm] + [-ContentSharingInExternalMeetings ] + [-Copilot ] + [-CopyRestriction ] + [-Description ] + [-DesignatedPresenterRoleMode ] + [-DetectSensitiveContentDuringScreenSharing ] + [-EnrollUserOverride ] + [-ExplicitRecordingConsent ] + [-ExternalMeetingJoin ] + [-Force] + [-IPAudioMode ] + [-IPVideoMode ] + [-InfoShownInReportMode ] + [-InMemory] + [-LiveCaptionsEnabledType ] + [-LiveInterpretationEnabledType ] + [-LiveStreamingMode ] + [-LobbyChat ] + [-MediaBitRateKb ] + [-MeetingChatEnabledType ] + [-MeetingInviteLanguages ] + [-NewMeetingRecordingExpirationDays ] + [-NoiseSuppressionForDialInParticipants ] + [-ParticipantNameChange ] + [-PreferredMeetingProviderForIslandsMode ] + [-QnAEngagementMode ] + [-RecordingStorageMode ] + [-RoomAttributeUserOverride ] + [-RoomPeopleNameUserOverride ] + [-ScreenSharingMode ] + [-SmsNotifications ] + [-SpeakerAttributionMode ] + [-StreamingAttendeeMode ] + [-TeamsCameraFarEndPTZMode ] + [-Tenant ] + [-UsersCanAdmitFromLobby ] + [-VideoFiltersMode ] + [-VoiceIsolation ] + [-VoiceSimulationInInterpreter ] + [-WatermarkForAnonymousUsers ] + [-WatermarkForCameraVideoOpacity ] + [-WatermarkForCameraVideoPattern ] + [-WatermarkForScreenSharingOpacity ] + [-WatermarkForScreenSharingPattern ] + [-AllowedUsersForMeetingDetails ] + [-RealTimeText ] + [-WhatIf] + [-WhoCanRegister ] + [] ``` ## DESCRIPTION @@ -45,7 +132,7 @@ The CsTeamsMeetingPolicy cmdlets enable administrators to control the type of me The New-CsTeamsMeetingPolicy cmdlet allows administrators to define new meeting policies that can be assigned to particular users to control Teams features related to meetings. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### -------------------------- EXAMPLE 1 -------------------------- ``` New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True ``` @@ -53,8 +140,7 @@ New-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True The command shown in Example 1 uses the New-CsTeamsMeetingPolicy cmdlet to create a new meeting policy with the Identity SalesMeetingPolicy. This policy will use all the default values for a meeting policy except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. - -### -------------------------- EXAMPLE 2 -------------------------- +### -------------------------- EXAMPLE 2 -------------------------- ``` New-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False ``` @@ -63,11 +149,49 @@ In Example 2, the New-CsTeamsMeetingPolicy cmdlet is used to create a meeting po In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. All other policy properties will use the default values. - ## PARAMETERS +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out. +Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to #prohibit anonymous users from dialing out. > [!NOTE] > This parameter is temporarily disabled. @@ -87,7 +211,7 @@ Accept wildcard characters: False ### -AllowAnonymousUsersToJoinMeeting > [!NOTE] -> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check https://docs.microsoft.com/microsoftteams/meeting-settings-in-teams for details. +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. @@ -118,25 +242,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedAnonymousJoinClientTypes -A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](/azure/communication-services/concepts/join-teams-meeting.md). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. - -The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. +### -AllowAnnotations +This setting will allow admins to choose which users will be able to use the Annotation feature. ```yaml -Type: List +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Empty List +Default value: None Accept pipeline input: False Accept wildcard characters: False -``` - -### -AllowChannelMeetingScheduling -Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. +``` + +### -AllowAvatarsInGallery +If admins disable avatars in 2D meetings, then users cannot represent themselves as avatars in the Gallery view. This does not disable avatars in Immersive view. ```yaml Type: Boolean @@ -150,8 +272,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCloudRecording -Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. ```yaml Type: Boolean @@ -160,13 +282,17 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalParticipantGiveRequestControl -Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting +### -AllowCarbonSummary + +This setting will enable Tenant Admins to enable/disable the sharing of location data necessary to provide the end of meeting carbon summary screen for either the entire tenant or for a particular user. If set to True the meeting organizer will share their location to the client of the participant to enable the calculation of distance and the resulting carbon. + +>[!NOTE] +>Location data will not be visible to the organizer or participants in this case and only carbon avoided will be shown. If set to False then organizer location data will not be shown and no carbon summary screen will be displayed to the participants. ```yaml Type: Boolean @@ -180,26 +306,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video +### -AllowCartCaptionsScheduling +Determines whether a user can add a URL for captions from a Communications Access Real-Time Translation (CART) captioner for providing real-time captions in meetings. + +Possible values are: + +- **EnabledUserOverride**: CART captions are available by default but you can disable them. +- **DisabledUserOverride**: If you would like users to be able to use CART captions in meetings but they are disabled by default. +- **Disabled**: If you do not want to allow CART captions in meetings. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: DisabledUserOverride Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAudioMode -Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting. +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -210,11 +342,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPVideoMode -Determines whether video can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming video in the meeting. Set this to DISABLED to prohibit outgoing and incoming video in the meeting. Invalid value combination IPVideoMode: EnabledOutgoingIncoming and IPAudioMode: Disabled +### -AllowCloudRecording +Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -225,41 +357,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings in a channel. Set this to TRUE to allow a user to start ad-hoc meetings in a channel. Set this to FALSE to prohibit the user from starting ad-hoc meetings in a channel. +### -AllowDocumentCollaboration +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. +### -AllowedUsersForMeetingContext + +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOutlookAddIn -Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client +### -AllowEngagementReport +Determines whether users are allowed to download the attendee engagement report. Set this to Enabled to allow the user to download the report. Set this to Disabled to prohibit the user to download it. ForceEnabled will enable attendee report generation and prohibit meeting organizer from disabling it. + +Possible values: + +- Enabled +- Disabled +- ForceEnabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -270,8 +409,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantGiveRequestControl -Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting +### -AllowExternalNonTrustedMeetingChat + +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. ```yaml Type: Boolean @@ -285,8 +425,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPowerPointSharing -Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit +### -AllowExternalParticipantGiveRequestControl +Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting ```yaml Type: Boolean @@ -300,8 +440,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetingScheduling -Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user +### -AllowImmersiveView +If admins have disabled avatars, this does not disable using avatars in Immersive view on Teams desktop or web. Additionally, it does not prevent users from joining the Teams meeting on VR headsets. ```yaml Type: Boolean @@ -315,8 +455,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedNotes -Determines whether users are allowed to take shared notes. Set this to TRUE to allow. Set this to FALSE to prohibit +### -AllowIPAudio +Determines whether audio is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their audio. Set this to FALSE to prohibit the user from sharing their audio. ```yaml Type: Boolean @@ -325,13 +465,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTranscription -Determines whether real-time and/or post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video ```yaml Type: Boolean @@ -344,27 +484,24 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCartCaptionsScheduling -Determines whether a user can add a URL for captions from a Communications Access Real-Time Translation (CART) captioner for providing real-time captions in meetings. -Possible values are: -- **EnabledUserOverride**: CART captions are available by default but you can disable them. -- **DisabledUserOverride**: If you would like users to be able to use CART captions in meetings but they are disabled by default. -- **Disabled**: If you do not want to allow CART captions in meetings. + +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: DisabledUserOverride +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWhiteboard -Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit +### -AllowMeetNow +Determines whether a user can start ad-hoc meetings in a channel. Set this to TRUE to allow a user to start ad-hoc meetings in a channel. Set this to FALSE to prohibit the user from starting ad-hoc meetings in a channel. ```yaml Type: Boolean @@ -373,25 +510,16 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoAdmittedUsers -Determines what types of participants will automatically be added to meetings organized by this user. -Possible values are: -- **EveryoneInCompany**, if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. -- **EveryoneInSameAndFederatedCompany**, if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. -- **Everyone**, if you'd like to admit anonymous users by default. -- **OrganizerOnly**, if you would like that only meeting organizers can bypass the lobby. -- **EveryoneInCompanyExcludingGuests**, if you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately. -- **InvitedUsers**, if you would like that only meeting organizers and invited users can bypass the lobby. - -This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). +### -AllowMeetingCoach +This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. If set to False, then users will not have the option to turn on Meeting Coach during calls. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -402,27 +530,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text about the meeting policy. -For example, the Description might indicate the users the policy should be assigned to. +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. + +Possible values: + +- true +- false ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -433,11 +565,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. +### -AllowNDIStreaming +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -448,41 +580,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy being created. +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookups can be made by users who are not Enterprise Voice enabled. It is used to enable Network Roaming policies. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. +### -AllowOrganizersToOverrideLobbySettings +Set this parameter to true to enable Organizers to override lobby settings. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -AllowOutlookAddIn +Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: @@ -493,34 +625,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScreenSharingMode -Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. +### -AllowPrivateMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -531,14 +655,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -547,46 +670,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreferredMeetingProviderForIslandsMode -Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: TeamsAndSfb +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoFiltersMode -Determines the background effects that a user can configure in the Teams client. Possible values are: - -- NoFilters: No filters are available. -- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://docs.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). -- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. -- AllFilters: All filters are available, including custom images. This is the default value. +### -AllowPSTNUsersToBypassLobby +Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to True, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: AllFilters +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEngagementReport -Determines whether users are allowed to download the attendee engagement report. Set this to Enabled to allow the user to download the report. Set this to Disabled to prohibit the user to download it. +### -AllowRecordingStorageOutsideRegion +Allow storing recording outside of region. All meeting recordings will be permanently stored in another region, and can't be migrated. For more info, see . ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -597,7 +715,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNDIStreaming +### -AllowScreenContentDigitization This parameter is reserved for internal Microsoft use. ```yaml @@ -612,32 +730,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedPresenterRoleMode -Determines if users can change the default value of the _Who can present?_ setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings. - -Possible values are: -- EveryoneUserOverride: All meeting participants can be presenters. This is the default value. This parameter corresponds to the _Everyone_ setting in Teams. -- EveryoneInCompanyUserOverride: Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the _People in my organization_ setting in Teams. -- EveryoneInSameAndFederatedCompanyUserOverride: Authenticated users in the organization, including guest users and users from federated organizations, can be presenters. This parameter corresponds to the _People in my organization and trusted organizations_ setting in Teams. -- OrganizerOnlyUserOverride: Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the _Only me_ setting in Teams. +### -AllowSharedNotes +Determines whether users are allowed to take shared notes. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: EveryoneUserOverride +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPSTNUsersToBypassLobby -Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to True, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting. +### -AllowTasksFromTranscript +This policy setting allows for the extraction of AI-Assisted Action Items/Tasks from the Meeting Transcript. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -648,8 +760,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPAudio -Determines whether audio is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their audio. Set this to FALSE to prohibit the user from sharing their audio. +### -AllowTrackingInReport +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -658,13 +770,13 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOrganizersToOverrideLobbySettings -Set this parameter to true to enable Organizers to override lobby settings. +### -AllowTranscription +Determines whether real-time and/or post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml Type: Boolean @@ -673,14 +785,15 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AllowUserToJoinExternalMeeting Possible values are: -- Enabled + +- Enabled - FederatedOnly - Disabled @@ -696,42 +809,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnrollUserOverride -Possible values are: -- Disabled -- Enabled +### -AllowWatermarkCustomizationForCameraVideo +Allows the admin to grant customization permissions to a meeting organizer ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingAttendeeMode -Possible values are: -- Disabled -- Enabled +### -AllowWatermarkCustomizationForScreenSharing +Allows the admin to grant customization permissions to a meeting organizer ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowBreakoutRooms -Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean @@ -740,31 +849,28 @@ Aliases: Required: False Position: Named -Default value: True +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamsCameraFarEndPTZMode -Possible values are: -- Disabled -- AutoAcceptInTenant -- AutoAcceptAll +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: Disabled +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingReactions -Set to false to disable Meeting Reactions. +### -AllowWhiteboard +Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit ```yaml Type: Boolean @@ -773,19 +879,23 @@ Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingChatEnabledType -Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: + +- \ +- RTMP ```yaml Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -793,30 +903,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingRegistration -Controls if a user can create a webinar meeting. The default value is True. +### -AnonymousUserAuthenticationMethod +Determines how anonymous users will be authenticated when joining a meeting. -Possible values: -- true -- false +Possible values are: +- **OneTimePasscode**, if you would like anonymous users to be sent a one time passcode to their email when joining a meeting +- **None**, if you would like to disable authentication for anonymous users joining a meeting ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named -Default value: None +Default value: OneTimePasscode Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowRecordingStorageOutsideRegion -Allow storing recording outside of region. All meeting recordings will be permanently stored in another region, and can't be migrated. For more info, see https://aka.ms/in-region. +### -AttendeeIdentityMasking +This setting will allow admins to enable or disable Masked Attendee mode in Meetings. Masked Attendee meetings will hide attendees' identifying information (e.g., name, contact information, profile photo). + +Possible Values: Enabled: Hides attendees' identifying information in meetings. Disabled: Does not allow attendees' to hide identifying information in meetings ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -827,11 +938,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenContentDigitization -This parameter is reserved for internal Microsoft use. +### -AudibleRecordingNotification +The setting controls whether recording notification is played to all attendees or just PSTN users. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -842,11 +953,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTrackingInReport -This parameter is reserved for internal Microsoft use. +### -AutoAdmittedUsers +Determines what types of participants will automatically be added to meetings organized by this user. +Possible values are: + +- **EveryoneInCompany**, if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. +- **EveryoneInSameAndFederatedCompany**, if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. +- **Everyone**, if you'd like to admit anonymous users by default. +- **OrganizerOnly**, if you would like that only meeting organizers can bypass the lobby. +- **EveryoneInCompanyExcludingGuests**, if you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately. +- **InvitedUsers**, if you would like that only meeting organizers and invited users can bypass the lobby. + +This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -857,8 +978,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveCaptionsEnabledType -Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. +### -AutomaticallyStartCopilot +> [!Note] +> This feature has not been fully released yet, so the setting will have no effect.* + +This setting gives admins the ability to auto-start Copilot. + +Possible values are: + +- Enabled +- Disabled ```yaml Type: String @@ -867,18 +996,30 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -RecordingStorageMode -This parameter can take two possible values: +### -BlockedAnonymousJoinClientTypes +A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. -- Stream -- OneDriveForBusiness +The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Empty List +Accept pipeline input: False +Accept wildcard characters: False +``` -Note: The change of storing Teams meeting recordings from Classic Stream to OneDrive and SharePoint (ODSP) has been completed as of August 30th, 2021. All recordings are now stored in ODSP. This change overrides the RecordingStorageMode parameter, and modifying the setting in PowerShell no longer has any impact. +### -CaptchaVerificationForMeetingJoin +Require a verification check for meeting join. ```yaml Type: String @@ -892,12 +1033,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoomAttributeUserOverride +### -ChannelRecordingDownload +Controls how channel meeting recordings are saved, permissioned, and who can download them. + Possible values: -- Off -- Distinguish -- Attribute +Allow - Saves channel meeting recordings to a "Recordings" folder in the channel. The permissions on the recording files will be based on the Channel SharePoint permissions. This is the same as any other file uploaded for the channel. +Block - Saves channel meeting recordings to a "Recordings\View only" folder in the channel. Channel owners will have full rights to the recordings in this folder, but channel members will have read access without the ability to download. ```yaml Type: String @@ -911,11 +1053,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionMode -Possible values: +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams -- EnabledUserOverride -- Disabled +Possible values are: + +Enabled +Disabled ```yaml Type: String @@ -929,16 +1073,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhoCanRegister -Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts, set the value to 'EveryoneInCompany'. +### -Confirm +Prompts you for confirmation before running the cmdlet. -Possible values: +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -- Everyone -- EveryoneInCompany +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSharingInExternalMeetings +This policy allows admins to determine whether the user can share content in meetings organized by external organizations. The user should have a Teams Premium license to be protected under this policy. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: @@ -949,37 +1103,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NewMeetingRecordingExpirationDays -Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. +### -Copilot +This setting allows the admin to choose whether Copilot will be enabled with a persisted transcript or a non-persisted transcript. -NOTE: You may opt to set Meeting Recordings to never expire by entering the value -1. +Possible values are: -NOTE: This parameter is available to be set, but will not be effective until this feature gets general availability. Please refer to the [roadmap (Feature ID: 84580)](https://www.microsoft.com/microsoft-365/roadmap?filters=&searchterms=84580) for more information on its delivery date. +- Enabled +- EnabledWithTranscript ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: EnabledWithTranscript Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingInviteLanguages -Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. -Note: All Teams supported languages can be specified using language codes. For more information about its delivery date, see the [roadmap (Feature ID: 81521)](https://www.microsoft.com/en-us/microsoft-365/roadmap?filters=&searchterms=81521). +### -CopyRestriction +Enables a setting that controls a meeting option which allows users to disable right-click or Ctrl+C to copy, Copy link, Forward message, and Share to Outlook for meeting chat messages. -The preliminary list of available languages is shown below: -ar-SA,az-Latn-AZ,bg-BG,ca-ES,cs-CZ,cy-GB,da-DK,de-DE,el-GR,en-GB,en-US,es-ES,es-MX,et-EE,eu-ES,fi-FI,fil-PH,fr-CA,fr-FR,gl-ES,he-IL,hi-IN,hr-HR,hu-HU,id-ID,is-IS,it-IT,ja-JP,ka-GE,kk-KZ,ko-KR,lt-LT,lv-LV,mk-MK,ms-MY,nb-NO,nl-NL,nn-NO,pl-PL,pt-BR,pt-PT,ro-RO,ru-RU,sk-SK,sl-SL,sq-AL,sr-Latn-RS,sv-SE,th-TH,tr-TR,uk-UA,vi-VN,zh-CN,zh-TW. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the meeting policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -988,8 +1154,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNetworkConfigurationSettingsLookup -Determines whether network configuration setting lookups can be made by users who are not Enterprise Voice enabled. It is used to enable Network Roaming policies. +### -DesignatedPresenterRoleMode +Determines if users can change the default value of the _Who can present?_ setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings. + +Possible values are: + +- EveryoneUserOverride: All meeting participants can be presenters. This is the default value. This parameter corresponds to the _Everyone_ setting in Teams. +- EveryoneInCompanyUserOverride: Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the _People in my organization_ setting in Teams. +- EveryoneInSameAndFederatedCompanyUserOverride: Authenticated users in the organization, including guest users and users from federated organizations, can be presenters. This parameter corresponds to the _People in my organization and trusted organizations_ setting in Teams. +- OrganizerOnlyUserOverride: Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the _Only me_ setting in Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EveryoneUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetectSensitiveContentDuringScreenSharing +Allows the admin to enable sensitive content detection during screen share. ```yaml Type: Boolean @@ -998,22 +1186,43 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveStreamingMode -Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP). +### -EnrollUserOverride +Possible values are: -Possible values are: -- Disabled (default) +- Disabled - Enabled ```yaml Type: String Parameter Sets: (All) Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitRecordingConsent +Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. + +Possible Values: + +- Enabled: Explicit consent, requires participant agreement. +- Disabled: Implicit consent, does not require participant agreement. +- LegitimateInterest: Legitimate interest, less restrictive consent to meet legitimate interest without requiring explicit agreement from participants. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + Required: False Position: Named Default value: None @@ -1021,10 +1230,730 @@ Accept pipeline input: False Accept wildcard characters: False ``` -## INPUTS +### -ExternalMeetingJoin +Possible values are: -### None +- EnabledForAnyone +- EnabledForTrustedOrgs +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledForAnyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfoShownInReportMode +This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMode +Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMode +Determines whether video can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming video in the meeting. Set this to DISABLED to prohibit outgoing and incoming video in the meeting. Invalid value combination IPVideoMode: EnabledOutgoingIncoming and IPAudioMode: Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveInterpretationEnabledType +Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. + +Possible values are: + +DisabledUserOverride, if you would like users to be able to use interpretation in meetings but by default it is disabled. +Disabled, prevents the option to be enabled in Meeting Options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveStreamingMode +Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP). + +Possible values are: + +- Disabled (default) +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LobbyChat + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether chat messages are allowed in the lobby. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingChatEnabledType +Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInviteLanguages +Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. + +> [!NOTE] +> All Teams supported languages can be specified using language codes. For more information about its delivery date, see the [roadmap (Feature ID: 81521)](https://www.microsoft.com/microsoft-365/roadmap?filters=&searchterms=81521). + +The preliminary list of available languages is shown below: + +`ar-SA,az-Latn-AZ,bg-BG,ca-ES,cs-CZ,cy-GB,da-DK,de-DE,el-GR,en-GB,en-US,es-ES,es-MX,et-EE,eu-ES,fi-FI,fil-PH,fr-CA,fr-FR,gl-ES,he-IL,hi-IN,hr-HR,hu-HU,id-ID,is-IS,it-IT,ja-JP,ka-GE,kk-KZ,ko-KR,lt-LT,lv-LV,mk-MK,ms-MY,nb-NO,nl-NL,nn-NO,pl-PL,pt-BR,pt-PT,ro-RO,ru-RU,sk-SK,sl-SL,sq-AL,sr-Latn-RS,sv-SE,th-TH,tr-TR,uk-UA,vi-VN,zh-CN,zh-TW`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewMeetingRecordingExpirationDays +Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. + +> [!NOTE] +> You may opt to set Meeting Recordings to never expire by entering the value -1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoiseSuppressionForDialInParticipants + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Control Noises Supression Feature for PST legs joining a meeting. + +Possible Values: + +- MicrosoftDefault +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParticipantNameChange +This setting will enable Tenant Admins to turn on/off participant renaming feature. + +Possible Values: Enabled: Turns on the Participant Renaming feature. Disabled: Turns off the Particpant Renaming feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMeetingProviderForIslandsMode +Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TeamsAndSfb +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QnAEngagementMode +This setting enables Microsoft 365 Tenant Admins to Enable or Disable the Questions and Answers experience (Q+A). When Enabled, Organizers can turn on Q+A for their meetings. When Disabled, Organizers cannot turn on Q+A in their meetings. The setting is enforced when a meeting is created or is updated by Organizers. Attendees can use Q+A in meetings where it was previously added. Organizers can remove Q+A for those meetings through Teams and Outlook Meeting Options. Possible values: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingStorageMode +This parameter can take two possible values: + +- Stream +- OneDriveForBusiness + +> [!Note] +> The change of storing Teams meeting recordings from Classic Stream to OneDrive and SharePoint (ODSP) has been completed as of August 30th, 2021. All recordings are now stored in ODSP. This change overrides the RecordingStorageMode parameter, and modifying the setting in PowerShell no longer has any impact. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomAttributeUserOverride +Possible values: + +- Off +- Distinguish +- Attribute + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomPeopleNameUserOverride +Enabling people recognition requires the tenant CsTeamsMeetingPolicy roomPeopleNameUserOverride to be "On" and roomAttributeUserOverride to be Attribute for allowing individual voice and face profiles to be used for recognition in meetings. + +> [!Note] +> In some locations, people recognition can't be used due to local laws or regulations. +Possible values: + +- On +- Off + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScreenSharingMode +Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmsNotifications +Participants can sign up for text message meeting reminders. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionMode +Possible values: + +- EnabledUserOverride +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingAttendeeMode +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCameraFarEndPTZMode +Possible values are: + +- Disabled +- AutoAcceptInTenant +- AutoAcceptAll + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanAdmitFromLobby +This policy controls who can admit from the lobby. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoFiltersMode +Determines the background effects that a user can configure in the Teams client. Possible values are: + +- NoFilters: No filters are available. +- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://learn.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). +- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. +- AllFilters: All filters are available, including custom images. This is the default value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: AllFilters +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceIsolation +Determines whether you provide support for your users to enable voice isolation in Teams meeting calls. + +Possible values are: + +- Enabled (default) +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForAnonymousUsers +Determines the meeting experience and watermark content of an anonymous user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoOpacity +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoPattern +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingOpacity +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingPattern +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +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 +``` + +### -WhoCanRegister +Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts, set the value to 'EveryoneInCompany'. + +Possible values: + +- Everyone +- EveryoneInCompany + +```yaml +Type: Object +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/p/?LinkID=113216). + +## INPUTS + +### None ## OUTPUTS diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..48a5347d44 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/New-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# New-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell + New-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-HiddenMeetingTemplates] [-Description ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden meeting template IDs. The template IDs passed into the `HiddenMeetingTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamsMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplateconfiguration) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsfirstpartymeetingtemplateconfiguration) respectively. + +## EXAMPLES + +### Example 1 - Creating a new meeting template permission policy + +Assuming there are two valid templates with IDs `firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748` and `customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056`, we will first create the `HiddenMeetingTemplate` objects. + +The next step would be to create the policy instance. +```powershell +$hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056 +$hiddentemplate_2 = New-CsTeamsHiddenMeetingTemplate -Id firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748 + +New-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) -Description "This is a test policy" +``` + +```output +Identity : Tag:Test_Policy +HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056, firstparty_e514e598-fba6-4e1f-b8b3-138dd3bca748} +Description : This is a test policy +``` + +## PARAMETERS + +### -Identity + +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenMeetingTemplates + +The list of meeting template IDs to hide. +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). + +```yaml +Type: HiddenMeetingTemplate[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate) + +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md new file mode 100644 index 0000000000..f25c5317c1 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md @@ -0,0 +1,771 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmessagingpolicy +applicable: Microsoft Teams +title: New-CsTeamsMessagingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsMessagingPolicy + +## SYNOPSIS +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +## SYNTAX + +```powershell +New-CsTeamsMessagingPolicy [[-Identity] ] + [-AllowChatWithGroup ] + [-AllowCommunicationComplianceEndUserReporting ] + [-AllowCustomGroupChatAvatars ] + [-AllowExtendedWorkInfoInSearch ] + [-AllowFluidCollaborate ] + [-AllowFullChatPermissionUserToDeleteAnyMessage ] + [-AllowGiphy ] + [-AllowGiphyDisplay ] + [-AllowGroupChatJoinLinks ] + [-AllowImmersiveReader ] + [-AllowMemes ] + [-AllowOwnerDeleteMessage ] + [-AllowPasteInternetImage ] + [-AllowPriorityMessages ] + [-AllowRemoveUser ] + [-AllowSecurityEndUserReporting ] + [-AllowSmartCompose] ] + [-AllowSmartReply ] + [-AllowStickers ] + [-AllowUrlPreviews ] + [-AllowUserChat ] + [-AllowUserDeleteChat ] + [-AllowUserDeleteMessage ] + [-AllowUserEditMessage ] + [-AllowUserTranslation ] + [-AllowVideoMessages ] + [-AudioMessageEnabledType ] + [-ChannelsInChatListEnabledType ] + [-ChatPermissionRole ] + [-Confirm] + [-CreateCustomEmojis ] + [-DeleteCustomEmojis ] + [-Description ] + [-DesignerForBackgroundsAndImages ] + [-Force] + [-GiphyRatingType ] + [-InMemory] + [-InOrganizationChatControl ] + [-ReadReceiptsEnabledType ] + [-Tenant ] + [-UsersCanDeleteBotMessages ] + [] + [-WhatIf] + ``` + +## DESCRIPTION +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet creates a new Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false +``` + +In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. +All other policy properties will use the default values. + +## PARAMETERS + +### -Identity +Unique identifier for the teams messaging policy to be created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowChatWithGroup + +This setting determines if users can chat with groups (Distribution, M365 and Security groups). Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCommunicationComplianceEndUserReporting + +This setting determines if users can report offensive messages to their admin for Communication Compliance. Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCustomGroupChatAvatars + +These settings enables, disables updating or fetching custom group chat avatars for the users included in the messaging policy. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExtendedWorkInfoInSearch +This setting enables/disables showing company name and department name in search results for MTO users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFluidCollaborate + +This field enables or disables Fluid Collaborate feature for users. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFullChatPermissionUserToDeleteAnyMessage + +This setting determines if users with the 'Full permissions' role can delete any group or meeting chat message within their tenant. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphy +Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphyDisplay + +Determines if Giphy images should be displayed that had been already sent or received in chat. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGroupChatJoinLinks + +This setting determines if users in a group chat can create and share join links for other users within the organization to join that chat. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveReader +Determines whether a user is allowed to use Immersive Reader for reading conversation messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMemes +Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOwnerDeleteMessage +Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit. + +If the `-AllowUserDeleteMessage` parameter is set to FALSE, the team owner will not be able to delete their own messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPasteInternetImage + +Determines if a user is allowed to paste internet-based images in compose. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPriorityMessages +Determines whether a user is allowed to send priorities messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRemoveUser +Determines whether a user is allowed to remove a user from a conversation. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSecurityEndUserReporting + +This setting determines if users can report any security concern posted in messages to their admin. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartCompose +Turn on this setting to let a user get text predictions for chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Con nombre +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartReply +Turn this setting on to enable suggested replies for chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickers +Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUrlPreviews +Use this setting to turn automatic URL previewing on or off in messages. Set this to TRUE to turn on. Set this to FALSE to turn off. +Note: [Optional Connected Experiences](https://learn.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for URL previews to be allowed. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserChat +Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteChat + +Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessage +Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessage +Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserTranslation +Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVideoMessages + +This setting determines if users can create and send video messages. Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioMessageEnabledType +Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels,ChatsOnly,Disabled. + +```yaml +Type: AudioMessageEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelsInChatListEnabledType +On mobile devices, enable to display favorite channels above recent chats. + +Possible values are: DisabledUserOverride,EnabledUserOverride. + +```yaml +Type: ChannelsInChatListEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChatPermissionRole +Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the environment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Restricted +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateCustomEmojis +This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteCustomEmojis +These settings enable and disable the editing and deletion of custom emojis and reactions for the users included in the messaging policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Allows you to provide a description of your policy to note the purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignerForBackgroundsAndImages + +This setting determines whether a user is allowed to create custom AI-powered backgrounds and images with MS Designer. + +Possible values are: Enabled, Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GiphyRatingType +Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InOrganizationChatControl + +This setting determines if chat regulation for internal communication in the tenant is allowed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadReceiptsEnabledType + +Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanDeleteBotMessages + +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Set-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy) + +[Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy) + +[Grant-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmessagingpolicy) + +[Remove-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md similarity index 69% rename from skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md index 8adf34c9db..8bd31ac80b 100644 --- a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md @@ -1,160 +1,175 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsmobilitypolicy -applicable: Skype for Business Online -title: New-CsTeamsMobilityPolicy -schema: 2.0.0 -manager: ritikag -ms.reviewer: ritikag ---- - - -# New-CsTeamsMobilityPolicy - -## SYNOPSIS -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -## SYNTAX - -``` -New-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] - [-IPAudioMobileMode ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -The New-CsTeamsMobilityPolicy cmdlet lets an Admin create a custom teams mobility policy to assign to particular sets of users. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsMobilityPolicy -Identity SalesMobilityPolicy -IPAudioMobileMode "WifiOnly" -``` - -The command shown in Example 1 uses the New-CsTeamsMobilityPolicy cmdlet to create a new Teams Mobility Policy with the Identity SalesMobilityPolicy and IPAudioMobileMode equal to WifiOnly. - - -## 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 -``` - -### -Description -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppress all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAudioMobileMode -When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPVideoMobileMode -When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy that you are creating. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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 +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmobilitypolicy +applicable: Microsoft Teams +title: New-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# New-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +``` +New-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] + [-IPAudioMobileMode ] [-Identity] ] [-MobileDialerPreference ] [-InMemory] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The New-CsTeamsMobilityPolicy cmdlet lets an Admin create a custom teams mobility policy to assign to particular sets of users. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsMobilityPolicy -Identity SalesMobilityPolicy -IPAudioMobileMode "WifiOnly" +``` + +The command shown in Example 1 uses the New-CsTeamsMobilityPolicy cmdlet to create a new Teams Mobility Policy with the Identity SalesMobilityPolicy and IPAudioMobileMode equal to WifiOnly. + +## 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 +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMobileMode +When set to WifiOnly, prohibits the user from making and receiving calls or joining meetings using VoIP calls on the mobile device while on a cellular data connection. Possible values are: WifiOnly, AllNetworks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMobileMode +When set to WifiOnly, prohibits the user from making and receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on a cellular data connection. Possible values are: WifiOnly, AllNetworks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 +``` + +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md similarity index 84% rename from skype/skype-ps/skype/New-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md index 50bffa61d5..54b53972d8 100644 --- a/skype/skype-ps/skype/New-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamsnetworkroamingpolicy +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsnetworkroamingpolicy applicable: Microsoft Teams title: New-CsTeamsNetworkRoamingPolicy author: TristanChen-msft ms.author: jiaych -ms.reviewer: +ms.reviewer: manager: mreddy schema: 2.0.0 --- @@ -20,7 +20,7 @@ New-CsTeamsNetworkRoamingPolicy allows IT Admins to create policies for Network ## SYNTAX ``` -New-CsTeamsNetworkRoamingPolicy [-Tenant ] [-Identity ] [-AllowIPVideo ] [-MediaBitRateKb ] [-Description ] +New-CsTeamsNetworkRoamingPolicy [-Tenant ] [-Identity ] [-AllowIPVideo ] [-MediaBitRateKb ] [-Description ] [] ``` ## DESCRIPTION @@ -28,9 +28,9 @@ Creates new Teams Network Roaming Policies configured for use in your organizati The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. -More on the impact of bit rate setting on bandwidth can be found [here](https://docs.microsoft.com/microsoftteams/prepare-network). +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). -To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. +To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. ## EXAMPLES @@ -66,7 +66,7 @@ Accept wildcard characters: False ``` ### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. ```yaml @@ -111,6 +111,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 diff --git a/skype/skype-ps/skype/New-CsTeamsPinnedApp.md b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md similarity index 92% rename from skype/skype-ps/skype/New-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/New-CsTeamsPinnedApp.md index ed45bafa47..6c96bf3b11 100644 --- a/skype/skype-ps/skype/New-CsTeamsPinnedApp.md +++ b/teams/teams-ps/teams/New-CsTeamsPinnedApp.md @@ -1,11 +1,14 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: tmp_1cmcv0jw.3l2 +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamspinnedapp +title: New-CsTeamsPinnedApp schema: 2.0.0 -ms.reviewer: +ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # New-CsTeamsPinnedApp @@ -15,10 +18,7 @@ author: tomkau As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . - - - +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## SYNTAX @@ -39,7 +39,7 @@ New-CsTeamsPinnedApp [-Tenant ] -Parent -Id -Orde As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## EXAMPLES @@ -200,14 +200,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..be3f26d1a2 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,137 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: New-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# New-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +New-CsTeamsRecordingRollOutPolicy [-MeetingRecordingOwnership ] [-Identity] [-Force] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The New-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to define new CsTeamsRecordingRollOutPolicy that can be assigned to particular users to control Teams features related to meetings. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy -MeetingRecordingOwnership MeetingOrganizer +``` + +The command shown in Example 1 uses the New-CsTeamsRecordingRollOutPolicy cmdlet to create a new TeamsRecordingRollOutPolicy with the Identity OrganizerPolicy. +This policy will set MeetingRecordingOwnership to MeetingOrganizer. Recordings for this policy group's users as organizer would get saved to organizers' own OneDrive. + +## 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 +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingRecordingOwnership +Specifies where the meeting recording get stored. Possible values are: +- MeetingOrganizer +- RecordingInitiator + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### TeamsRecordingRollOutPolicy.Cmdlets.TeamsRecordingRollOutPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..ad5c601ece --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,225 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsroomvideoteleconferencingpolicy +title: New-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Creates a new TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +New-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-AreaCode ] [-Description ] + [-Enabled ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..1b61b77f9d --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,201 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +title: New-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +--- + +# New-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Use the New-CsTeamsSharedCallingRoutingPolicy cmdlet to configure a shared calling routing policy. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsSharedCallingRoutingPolicy [-Identity] [-EmergencyNumbers ] + [-ResourceAccount ] [-Description ] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams shared calling routing policy configures the caller ID for normal outbound PSTN and emergency calls made by users enabled for Shared Calling using this policy instance. + +The caller ID for normal outbound PSTN calls is the phone number assigned to the resource account specified in the policy instance. Typically this is the organization's main auto attendant phone number. Callbacks will go to the auto attendant and the PSTN caller can use the auto attendant to be transferred to the shared calling user. + +When a shared calling user makes an emergency call, the emergency services need to be able to make a direct callback to the user who placed the emergency call. One of the defined emergency numbers is used for this purpose as caller ID for the emergency call. It will be reserved for the next 60 minutes and any inbound call to that number will directly ring the shared calling user who made the emergency call. If no emergency numbers are defined, the phone number of the resource account is used as caller ID. If no free emergency numbers are available, the first number in the list is reused. + +The emergency call will contain the location of the shared calling user. The location will be either the dynamic emergency location obtained by the Teams client or if that is not available the static location assigned to the phone number of the resource account used in the shared calling policy instance. + +## EXAMPLES + +### Example 1 +``` +$ra = Get-CsOnlineUser -Identity ra1@contoso.com +$PhoneNumber=Get-CsPhoneNumberAssignment -AssignedPstnTargetId ra1@contoso.com +$CivicAddress = Get-CsOnlineLisCivicAddress -City Seattle +Set-CsPhoneNumberAssignment -LocationId $CivicAddress.DefaultLocationId -PhoneNumber $PhoneNumber.TelephoneNumber +New-CsTeamsSharedCallingRoutingPolicy -Identity Seattle -ResourceAccount $ra.Identity -EmergencyNumbers @{add='+14255556677','+14255554321'} -Description 'Seattle' +``` +The command shown in Example 1 gets the identity and phone number assigned to the Teams resource account ra1@contoso.com, sets the location of the phone number to be the Seattle location, and creates a new Shared Calling policy called Seattle that is using the Teams resource account ra1@contoso.com and the emergency numbers +14255556677 and +14255554321. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the new policy instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyNumbers +An array of phone numbers used as caller ID on emergency calls. + +The emergency numbers must be routable for inbound PSTN calls, and for Calling Plan and Operator Connect phone numbers, must be available within the organization. + +The emergency numbers specified must all be of the same phone number type and country as the phone number assigned to the specified resource account. If the resource account has a Calling Plan service number assigned, the emergency numbers need to be Calling Plan subscriber numbers. + +The emergency numbers must be unique and can't be reused in other shared calling policy instances. The emergency numbers can't be assigned to any user or resource account. + +If no emergency numbers are configured, the phone number of the resource account is used as the Caller ID for the emergency call. + +```yaml +Type: System.Management.Automation.PSListModifier[String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +## NOTES +In some Calling Plan markets, you are not allowed to set the location on service numbers. In this instance, kindly contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +If you are attempting to use a resource account with an Operator Connect phone number assigned, you should confirm support for Shared Calling with your operator. + +Shared Calling is not supported for Calling Plan service phone numbers in Romania, the Czech Republic, Hungary, Singapore, New Zealand, Australia, and Japan. A limited number of existing Calling Plan service phone numbers in other countries are also not supported for Shared Calling. For such service phone numbers, please contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..f09cf35e77 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -0,0 +1,367 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: New-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection +schema: 2.0.0 +--- + +# New-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet creates a new workforce management (WFM) connection. + +## SYNTAX + +### New (Default) +```powershell +New-CsTeamsShiftsConnection -Body [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### NewExpanded +```powershell +New-CsTeamsShiftsConnection -ConnectorId -ConnectorSpecificSettings -Name -State [-Authorization ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet creates a Shifts WFM connection. It allows the admin to set up the environment for creating connection instances. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2" + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1" + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" + cookieAuthUrl = "https://contoso.com/retail/data/login" + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output +{ +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +} +``` + +Returns the object of the created connection. + +In case of an error, we can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +### Example 2 + +```powershell +PS C:\> $result = New-CsTeamsShiftsConnection ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + +## PARAMETERS + +### -Body + +The request body. + +```yaml +Type: IConnectorInstanceRequest +Parameter Sets: New +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +The WFM connector ID. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connection name. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connection name. + +```yaml +Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificSettingsRequest +Parameter Sets: NewExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: NewExpanded +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 +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) + +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) + +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md index 48f5a363d3..0dcfcf6db0 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -5,13 +5,12 @@ title: New-CsTeamsShiftsConnectionBatchTeamMap author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap schema: 2.0.0 --- # New-CsTeamsShiftsConnectionBatchTeamMap - ## SYNOPSIS This cmdlet submits an operation connecting multiple Microsoft Teams teams and Workforce management (WFM) teams. @@ -24,7 +23,7 @@ New-CsTeamsShiftsConnectionBatchTeamMap -ConnectorInstanceId -TeamMappi ## DESCRIPTION -This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for asynchronization of shifts related data. It acts like an async batch request of [New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md). You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md). +This cmdlet connects multiple Microsoft Teams teams and WFM teams to allow for synchronization of shifts related data. It initiates an asynchronous job to map the WFM teams to the Microsoft Teams teams. You can check the operation status by running [Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation). ## EXAMPLES @@ -98,6 +97,4 @@ Please check the example section for the format of TeamMap. ## RELATED LINKS -[Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) - -[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md) +[Get-CsTeamsShiftsConnectionOperation](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionoperation) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md index a5d9319a51..9570c08ad4 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -1,83 +1,90 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: New-CsTeamsShiftsConnectionInstance -author: gucsun -ma.author: gucsun -manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance +author: leonardospina +ms.author: lespina +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance schema: 2.0.0 --- # New-CsTeamsShiftsConnectionInstance ## SYNOPSIS - This cmdlet creates a Shifts connection instance. ## SYNTAX +### New (Default) ``` -New-CsTeamsShiftsConnectionInstance -ConnectorId -ConnectorSpecificSettingAdminApiUrl -ConnectorSpecificSettingCookieAuthUrl -ConnectorSpecificSettingEssApiUrl -ConnectorSpecificSettingFederatedAuthUrl -ConnectorSpecificSettingLoginPwd -ConnectorSpecificSettingLoginUserName -ConnectorSpecificSettingRetailWebApiUrl -ConnectorSpecificSettingSiteManagerUrl -Name -DesignatedActorId -EnabledConnectorScenario -EnabledWfiScenario -SyncFrequencyInMin [-ConnectorAdminEmail ] [] +New-CsTeamsShiftsConnectionInstance -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` -## DESCRIPTION +### NewExpanded +``` +New-CsTeamsShiftsConnectionInstance [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ][-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ][-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` +## DESCRIPTION This cmdlet creates a Shifts connection instance. It allows the admin to set up the environment for further connection settings. ## EXAMPLES ### Example 1 + ```powershell -New-CsTeamsShiftsConnectionInstance -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E9CD74" -ConnectorSpecificSettingAdminApiUrl "https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2" -ConnectorSpecificSettingCookieAuthUrl "https://www.contoso.com/retail/data/login" -ConnectorSpecificSettingEssApiUrl "https://www.contoso.com/retail/data/wfmess/api/v1-beta1" -ConnectorSpecificSettingFederatedAuthUrl "https://www.contoso.com/retail/data/login" -ConnectorSpecificSettingLoginPwd "MyPassword" -ConnectorSpecificSettingLoginUserName "MyUserName" -ConnectorSpecificSettingRetailWebApiUrl "https://www.contoso.com/retail/data/retailwebapi/api/v1" -ConnectorSpecificSettingSiteManagerUrl "https://www.contoso.com/retail/data/wfmsm/api/v1-beta2" -DesignatedActorId "123451fa-1b17-43cc-a417-34c156b99779" -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest" -EnabledWfiScenario "swapRequest", "openShiftRequest", "timeOffRequest" -Name "MyInstance" -SyncFrequencyInMin 10 -ConnectorAdminEmail "test@abc.com", "test2@abc.com" +PS C:\> $result = New-CsTeamsShiftsConnectionInstance ` +-connectionId "79964000-286a-4216-ac60-c795a426d61a" ` +-name "Cmdlet test instance" ` +-connectorAdminEmail @("admin@contoso.com", "superadmin@contoso.com") ` +-designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` +-State "Active" ` +-syncFrequencyInMin "10" ` +-SyncScenarioOfferShiftRequest "FromWfmToShifts" ` +-SyncScenarioOpenShift "FromWfmToShifts" ` +-SyncScenarioOpenShiftRequest "FromWfmToShifts" ` +-SyncScenarioShift "FromWfmToShifts" ` +-SyncScenarioSwapRequest "FromWfmToShifts" ` +-SyncScenarioTimeCard "FromWfmToShifts" ` +-SyncScenarioTimeOff "FromWfmToShifts" ` +-SyncScenarioTimeOffRequest "FromWfmToShifts" ` +-SyncScenarioUserShiftPreference "Disabled" +PS C:\> $result.ToJsonString() ``` + ```output { - "id": "WCI-648a8c8f-0ca3-460b-b71c-0d038d6d6e09", - "tenantId": "12345b34-ccb0-47e1-bdb7-e49db9c7c14a", - "name": "MyInstance", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E9CD74", - "name": "Contoso V1" - }, - "connectorSpecificSettings": { - "adminApiUrl": "https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2", - "siteManagerUrl": "https://www.contoso.com/retail/data/wfmsm/api/v1-beta2", - "essApiUrl": "https://www.contoso.com/retail/data/wfmess/api/v1-beta1", - "retailWebApiUrl": "https://www.contoso.com/retail/data/retailwebapi/api/v1", - "cookieAuthUrl": "https://www.contoso.com/retail/data/login", - "federatedAuthUrl": "https://www.contoso.com/retail/data/login" - }, - "enabledConnectorScenarios": [ - "Shift", - "SwapRequest", - "UserShiftPreferences", - "OpenShift", - "OpenShiftRequest", - "TimeOff", - "TimeOffRequest", - "TimeCard" - ], - "workforceIntegrationId": "WFI_fe5e773e-784d-4a19-be2b-808dde071d88", - "enabledWfiScenarios": [ - "SwapRequest", - "OpenShiftRequest", - "TimeOffRequest", - "TimeCard" - ], - "syncFrequencyInMin": 10, - "designatedActorId": "12345a2d-422c-4d4b-a2db-4cea80f98255", - "connectorAdminEmails": [ - "test@abc.com", - "test2@abc.com" - ], - "etag": "\"28007861-0000-0400-0000-60d3579b0000\"" + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "79964000-286a-4216-ac60-c795a426d61a", + "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" } ``` Returns the object of created connector instance. -In case of error, we can capture the error response as following: +In case of an error, we can capture the error response as follows: * Hold the cmdlet output in a variable: `$result=` @@ -87,31 +94,74 @@ In case of error, we can capture the error response as following: ## PARAMETERS -### -DesignatedActorId +### -Body -The ID of the connection instance creator. You can retrieve user ID from Azure portal or Graph Explorer. +The request body ```yaml -Type: String -Parameter Sets: (All) +Type: IConnectorInstanceRequest +Parameter Sets: New Aliases: -Applicable: Microsoft Teams + Required: True Position: Named Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId +### -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 +``` -The ID of the Shifts Connector. +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. + +```yaml +Type: String[] +Parameter Sets: NewExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -119,15 +169,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name - -The connector instance's name. +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph Api calls. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -135,15 +183,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario - -The connector enabled scenarios that are synced from the Workforce management (WFM) system to Shifts in Microsoft Teams. You can use [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) to get supported scenarios. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -151,15 +197,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario - -The WFI enabled scenarios that are synced from Shifts in MS Teams to WFM system. You can use [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) to get supported scenarios. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -167,15 +211,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin - -The sync frequency in minutes. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Integer -Parameter Sets: (All) +Type: String +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -183,15 +225,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingLoginUserName - -The login user name to WFM team. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -199,15 +239,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingLoginPwd - -The login password to WFM team. +### -SyncScenarioSwapRequest +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -215,15 +253,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingAdminApiUrl - -The admin API URL. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -231,15 +267,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingCookieAuthUrl - -The cookie authorization URL. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -247,15 +281,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingEssApiUrl +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The essential API URL. +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -263,15 +309,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingFederatedAuthUrl +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The federated authorization URL. +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. ```yaml -Type: String +Type: SendAsyncStep[] Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: Required: True Position: Named Default value: None @@ -279,31 +351,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingRetailWebApiUrl +### -Proxy +The URI for the proxy server to use. +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The retail web api URL. +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingSiteManagerUrl +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The site manager URL. +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -311,15 +406,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorAdminEmail +### -SyncFrequencyInMin +The sync frequency in minutes. + +```yaml +Type: Int32 +Parameter Sets: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The list of connector admin email addresses that receive result notifications. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +Aliases: wi Required: False Position: Named Default value: None @@ -332,16 +440,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest + ## OUTPUTS +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + ## NOTES ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) -[Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md deleted file mode 100644 index 07d7c81b36..0000000000 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: MicrosoftTeams -title: New-CsTeamsShiftsConnectionTeamMap -author: gucsun -ms.author: gucsun -manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionteammap -schema: 2.0.0 ---- - -# New-CsTeamsShiftsConnectionTeamMap - -## SYNOPSIS - -This cmdlet connects a Microsoft Teams team and a Workforce management (WFM) team. - -## SYNTAX - -``` -New-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId -TimeZone -WfmTeamId [] -``` - -## DESCRIPTION - -This cmdlet connects a Microsoft Teams team and a WFM team to allow for synchronization of shifts related data. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId "WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b" -TeamId 30b625bd-f0f7-4d5c-8793-9ccef5a63119 -TimeZone "America/Los_Angeles" -WfmTeamId "1000107" -``` -```output -TeamId TeamName WfmTeamId WfmTeamName ------- -------- --------- ----------- -30b625bd-f0f7-4d5c-8793-9ccef5a6311 1000107 -``` - -Maps the Teams team with ID `30b625bd-f0f7-4d5c-8793-9ccef5a63119` and WFM team with ID `1000107` in the instance with ID `WCI-4c231dd2-4451-45bd-8eea-bd68b40bab8b`. - -In case of error, we can capture the error response as following: - -* Hold the cmdlet output in a variable: `$result=` - -* To get the entire error message in Json: `$result.ToJsonString()` - -* To get the error object and object details: `$result, $result.Detail` - -## PARAMETERS - -### -ConnectorInstanceId - -The connection instance ID used to map teams. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamId - -The Teams team ID mapped. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WfmTeamId - -The WFM team ID mapped. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone - -The team's time zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -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-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) - -[Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) diff --git a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md index d9693151a5..57a7c3e428 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-teamsshiftspolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-teamsshiftspolicy +title: New-CsTeamsShiftsPolicy schema: 2.0.0 --- @@ -13,15 +14,15 @@ This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's pr ## SYNTAX -``` -New-CsTeamsShiftsPolicy [-Identity] [-EnableShiftPresence ] - [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] [-ShiftNoticeMessageCustom ] - [-AccessType ] [-AccessGracePeriodMinutes ] [-EnableScheduleOwnerPermissions ] [] +```powershell +New-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] + [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] + [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - +This cmdlet allows you to create a TeamsShiftPolicy instance. Use this to also set the policy name, schedule owner permissions, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). ## EXAMPLES @@ -34,7 +35,7 @@ Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always ### Example 2 ```powershell -PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -EnableShiftPresence $true -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false +PS C:\> New-CsTeamsShiftsPolicy -Identity OffShiftAccessMessage1Always -ShiftNoticeFrequency always -ShiftNoticeMessageType Message1 -AccessType UnrestrictedAccess_TeamsApp -AccessGracePeriodMinutes 5 -EnableScheduleOwnerPermissions $false ``` Creates a new instance of TeamsShiftsPolicy called OffShiftAccessMessage1Always and applies the provided values to its settings. @@ -61,7 +62,6 @@ Indicates the Teams access type granted to the user. Today, only unrestricted ac Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - ```yaml Type: String Parameter Sets: (All) @@ -74,21 +74,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableShiftPresence -Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ShiftNoticeFrequency Frequency of warning dialog displayed when user opens Teams. Select one of Always, ShowOnceOnChange, Never. @@ -105,18 +90,17 @@ Accept wildcard characters: False ``` ### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer’s timekeeping system. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' - ```yaml Type: String Parameter Sets: (All) @@ -174,10 +158,55 @@ 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None @@ -185,14 +214,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) -[Set-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) -[Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) -[Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..e4ca073509 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,160 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliance +title: New-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# New-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +### Identity (Default) + +```powershell +New-CsTeamsSurvivableBranchAppliance [-Identity] [-Description ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey + +```powershell +New-CsTeamsSurvivableBranchAppliance [-Description ] [-Site ] + [-MsftInternalProcessingMode ] -Fqdn [-WhatIf] [-Confirm] [] +``` + +## 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 +``` + +### -Description + +Free format text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fqdn + +The FQDN of the SBA. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the SBA. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..4fe55cb48c --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,119 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssurvivablebranchappliancepolicy +title: New-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# New-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +New-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-BranchApplianceFqdns ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..88462d4a72 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,163 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy +title: New-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# New-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Creates a new instance of the TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +New-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the policy with a name and a list of hidden Teams template IDs. The template IDs passed into the `HiddenTemplates` object must be valid existing template IDs. The current custom and first-party templates on a tenant can be fetched by [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist). + +## EXAMPLES + +### Example 1 + +Assuming there are two valid templates with IDs `com.microsoft.teams.template.ManageAProject` and `com.microsoft.teams.template.ManageAnEvent`, we will first create the `HiddenTemplate` objects. + +The next step would be to create the policy instance. +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >New-CsTeamsTemplatePermissionPolicy -Identity Foobar -HiddenTemplates $HiddenList +``` + +```output +Identity HiddenTemplates Description +-------- --------------- ----------- +Tag:Foobar {com.microsoft.teams.template.ManageAProject, com.microsoft.teams.template.ManageAnEvent} +``` + +## 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 +``` + +### -Description +Description of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### TeamsTemplatePermissionPolicy.Cmdlets.TeamsTemplatePermissionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsTranslationRule.md b/teams/teams-ps/teams/New-CsTeamsTranslationRule.md similarity index 81% rename from skype/skype-ps/skype/New-CsTeamsTranslationRule.md rename to teams/teams-ps/teams/New-CsTeamsTranslationRule.md index 029dd79110..e760bec361 100644 --- a/skype/skype-ps/skype/New-CsTeamsTranslationRule.md +++ b/teams/teams-ps/teams/New-CsTeamsTranslationRule.md @@ -1,195 +1,199 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csteamstranslationrule -applicable: Microsoft Teams -title: New-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# New-CsTeamsTranslationRule - -## SYNOPSIS -Cmdlet to create a new telephone number manipulation rule. - -## SYNTAX - -### Identity (Default) -``` -New-CsTeamsTranslationRule [-Identity] [-Description ] [-Pattern ] [-Translation ] [-WhatIf] [-Confirm] [] -``` - -### ParentAndRelativeKey -``` -New-CsTeamsTranslationRule -Name [-Description ] [-Pattern ] [-Translation ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -You can use this cmdlet to create a new number manipulation rule. The rule can be used, for example, in the settings of your SBC (Set-CSOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System - -## EXAMPLES - -### Example 1 -```powershell -New-CsTeamsTranslationRule -Identity 'AddPlus1' -Pattern '^(\d{10})$' -Translation '+1$1' -``` - -This example creates a rule that adds +1 to any ten digits number. For example, 2065555555 will be translated to +1206555555 - -### Example 2 -```powershell -New-CsTeamsTranslationRule -Identity 'StripPlus1' -Pattern '^\+1(\d{10})$' -Translation '$1' -``` - -This example creates a rule that strips +1 from any E.164 eleven digits number. For example, +12065555555 will be translated to 206555555 - -### Example 3 -```powershell -New-CsTeamsTranslationRule -Identity 'AddE164SeattleAreaCode' -Pattern '^(\d{4})$' -Translation '+120655$1' -``` - -This example creates a rule that adds +1206555 to any four digits number (converts it to E.164number). For example, 5555 will be translated to +1206555555 - -### Example 4 -```powershell -New-CsTeamsTranslationRule -Identity 'AddSeattleAreaCode' -Pattern '^(\d{4})$' -Translation '425555$1' -``` - -This example creates a rule that adds 425555 to any four digits number (converts to non-E.164 ten digits number). For example, 5555 will be translated to 4255555555 - -### Example 5 -```powershell -New-CsTeamsTranslationRule -Identity 'StripE164SeattleAreaCode' -Pattern '^\+1206555(\d{4})$' -Translation '$1' -``` - -This example creates a rule that strips +1206555 from any E.164 ten digits number. For example, +12065555555 will be translated to 5555 - - -## PARAMETERS - -### -Identity -The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. - - -```yaml -Type: String -Parameter Sets: (Identity) -Aliases: -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -A friendly description of the normalization rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that caller or callee number must match in order for this rule to be applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Translation -The regular expression pattern that will be applied to the number to convert it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the rule. - -```yaml -Type: String -Parameter Sets: (ParentAndRelativeKey) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. 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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -[Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) - -[Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) - -[Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) - -[Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule +applicable: Microsoft Teams +title: New-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to create a new telephone number manipulation rule. + +## SYNTAX + +### Identity (Default) +``` +New-CsTeamsTranslationRule [-Identity] [-Description ] [-Pattern ] [-Translation ] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsTranslationRule -Name [-Description ] [-Pattern ] [-Translation ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +You can use this cmdlet to create a new number manipulation rule. The rule can be used, for example, in the settings of your SBC (Set-CSOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System + +## EXAMPLES + +### Example 1 +```powershell +New-CsTeamsTranslationRule -Identity 'AddPlus1' -Pattern '^(\d{10})$' -Translation '+1$1' +``` + +This example creates a rule that adds +1 to any ten digits number. For example, 2065555555 will be translated to +1206555555 + +### Example 2 +```powershell +New-CsTeamsTranslationRule -Identity 'StripPlus1' -Pattern '^\+1(\d{10})$' -Translation '$1' +``` + +This example creates a rule that strips +1 from any E.164 eleven digits number. For example, +12065555555 will be translated to 206555555 + +### Example 3 +```powershell +New-CsTeamsTranslationRule -Identity 'AddE164SeattleAreaCode' -Pattern '^(\d{4})$' -Translation '+120655$1' +``` + +This example creates a rule that adds +1206555 to any four digits number (converts it to E.164number). For example, 5555 will be translated to +1206555555 + +### Example 4 +```powershell +New-CsTeamsTranslationRule -Identity 'AddSeattleAreaCode' -Pattern '^(\d{4})$' -Translation '425555$1' +``` + +This example creates a rule that adds 425555 to any four digits number (converts to non-E.164 ten digits number). For example, 5555 will be translated to 4255555555 + +### Example 5 +```powershell +New-CsTeamsTranslationRule -Identity 'StripE164SeattleAreaCode' -Pattern '^\+1206555(\d{4})$' -Translation '$1' +``` + +This example creates a rule that strips +1206555 from any E.164 ten digits number. For example, +12065555555 will be translated to 5555 + +### Example 6 +```powershell +New-CsTeamsTranslationRule -Identity 'GenerateFullNumber' -Pattern '^\+1206555(\d{4})$' -Translation '+1206555$1;ext=$1' +``` + +This example creates a rule that adds the last four digits of a phone number starting with +1206555 as the extension. For example, +12065551234 will be translated to +12065551234;ext=1234. + +## PARAMETERS + +### -Identity +The Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. + +```yaml +Type: String +Parameter Sets: (Identity) +Aliases: +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A friendly description of the normalization rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Translation +The regular expression pattern that will be applied to the number to convert it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule. + +```yaml +Type: String +Parameter Sets: (ParentAndRelativeKey) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. 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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md index 239a1c767e..cf47048628 100644 --- a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: New-CsTeamsUnassignedNumberTreatment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # New-CsTeamsUnassignedNumberTreatment @@ -15,11 +16,20 @@ schema: 2.0.0 ## SYNOPSIS Creates a new treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - ## SYNTAX -```powershell -New-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Pattern ] [-TargetType ] [-Target ] [-TreatmentPriority ] [-Description ] [-InMemory] [-TreatmentId ] [-Force] [-WhatIf] [-Confirm] [] +### Identity (Default) +``` +New-CsTeamsUnassignedNumberTreatment [-Identity] [-Description ] [-Pattern ] [-Target ] + [-TargetType ] [-TreatmentPriority ] + [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTeamsUnassignedNumberTreatment -TreatmentId [-Description ] [-Pattern ] [-Target ] + [-TargetType ] [-TreatmentPriority ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,7 +55,6 @@ New-CsTeamsUnassignedNumberTreatment -Identity TR1 -Pattern "^\+1555333\d{4}$" - This example creates a treatment that will route all calls to unassigned numbers in the range +1 (555) 333-0000 to +1 (555) 333-9999 to the announcement service, where the audio file MainAnnouncement.wav will be played to the caller. - ### Example 3 ```powershell $UserObjectId = (Get-CsOnlineUser -Identity user@contoso.com).Identity @@ -53,7 +62,6 @@ New-CsTeamsUnassignedNumberTreatment -Identity TR2 -Pattern "^\+15552224444$" -T ``` This example creates a treatment that will route all calls to the number +1 (555) 222-4444 to the user user@contoso.com. - ## PARAMETERS ### -Description @@ -73,10 +81,9 @@ Accept wildcard characters: False ### -Identity The Id of the treatment. - ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: (Identity) Aliases: Required: True @@ -86,7 +93,7 @@ Accept wildcard characters: False ``` ### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. +A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. ```yaml @@ -133,10 +140,10 @@ The identity of the treatment. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: (ParentAndRelativeKey) Aliases: -Required: False +Required: True Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -178,17 +185,17 @@ To route calls to unassigned Microsoft Calling Plan service numbers, your tenant Both inbound calls to Microsoft Teams and outbound calls from Microsoft Teams will have the called number checked against the unassigned number range. -If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to +If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. ## RELATED LINKS -[Import-CsOnlineAudioFile](https://docs.microsoft.com/powershell/module/skype/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) -[Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) -[Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) -[Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) -[Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..d439835fe4 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,315 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: New-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# New-CsTeamsUpdateManagementPolicy + +## SYNOPSIS + +Use this cmdlet to create Teams Update Management policy. + +## SYNTAX + +```powershell +New-CsTeamsUpdateManagementPolicy + [-DisabledInProductMessages ] + [-Description ] [-AllowManagedUpdates ] [-AllowPreview ] [-UpdateDayOfWeek ] + [-UpdateTime ] [-UpdateTimeOfDay ] [-AllowPublicPreview ] + [-AllowPrivatePreview ] [-UseNewTeamsClient ] + [-BlockLegacyAuthorization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. + +This cmdlet can be used to create a new policy to manage the visibility of some Teams in-product messages. Executing the cmdlet will suppress the corresponding category of messages from appearing for the specified user group. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" -DisabledInProductMessages @("91382d07-8b89-444c-bbcb-cfe43133af33") +``` + +Disable the in-product messages with the category "What's New". + +## 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 +``` + +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: + +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33| What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowManagedUpdates + +Enables/Disables managed updates for the user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPreview + +Indicates whether all feature flags are switched on or off. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivatePreview + +This setting will allow admins to allow users in their tenant to opt in to Private Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is Forced, then users will be switched to Private Preview. + +```yaml +Type: AllowPrivatePreview +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPublicPreview + +This setting will allow admins to allow users in their tenant to opt in to Public Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is FollowOfficePreview, then users will not be able to opt in and instead follow their Office channel, and be switched to Public Preview if their Office channel is CC (Preview). The ring switcher UI will be hidden in the Desktop Client. This is not applicable to the Web Client. + If it is Forced, then users will be switched to Public Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization + +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. + If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. + If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDayOfWeek + + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTime + +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppress all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 + +### TeamsUpdateManagementPolicy.Cmdlets.TeamsUpdateManagementPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..a8a03debbe --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsVdiPolicy.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvdipolicy +title: New-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# New-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +```powershell +New-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] + [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +The New-CsTeamsVdiPolicy cmdlet allows administrators to define new Vdi policies that can be assigned to particular users to control Teams features related to meetings on a VDI environment. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the New-CsTeamsVdiPolicy cmdlet to create a new Vdi policy with the Identity RestrictedUserPolicy. This policy will use all the default values for a vdi policy except one: VDI2Optimization; in this example, users with this policy will not be able to be VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the New-CsTeamsVdiPolicy cmdlet is used to create a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the default values. + +## 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 +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..e231df2c8c --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy +title: New-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +author: emmanuelrocha001 +manager: sonaggarwal +--- + +# New-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to create a new instance of the TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +``` +New-CsTeamsVirtualAppointmentsPolicy [-EnableSmsNotifications ] [-Identity] [-Force] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the TeamsVirtualAppointmentsPolicy. This policy can be used to tailor the virtual appointment template meeting experience. The parameter `EnableSmsNotifications` allows you to specify whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using the virtual appointment meeting template. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled True +``` +Creates a new policy instance with the identity enable-sms. `EnableSmsNotifications` will default to true if it is not specified. + +### Example 2 +```powershell +PS C:\> New-CsTeamsVirtualAppointmentsPolicy -Identity disable-sms -EnableSmsNotifications $false +``` +```output +Identity EnableSmsNotifications +-------- ---------------------- +Tag:sms-enabled False +``` +Creates a new policy instance with the identity sms-disabled. `EnableSmsNotifications` is set to the value specified in the command. + +## 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 +``` + +### -EnableSmsNotifications +This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### TeamsVirtualAppointmentsPolicy.Cmdlets.TeamsVirtualAppointmentsPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md index 87143dc367..fd60490292 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -1,49 +1,92 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/new-csteamsvoiceapplicationspolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy +title: New-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 +ROBOTS: NOINDEX --- # New-CsTeamsVoiceApplicationsPolicy ## SYNOPSIS -Creates a new Teams voice applications policy. TeamsVoiceApplications policy governs what permissions the supervisors/users have over auto attendants and call queues. + +Creates a new Teams voice applications policy. `TeamsVoiceApplications` policy governs what permissions the supervisors/users have over auto attendants and call queues. ## SYNTAX -``` -New-CsTeamsVoiceApplicationsPolicy [-Identity] [-AllowAutoAttendantAfterHoursGreetingChange ] +```powershell +New-CsTeamsVoiceApplicationsPolicy [-Identity] [-AllowAutoAttendantBusinessHoursGreetingChange ] - [-AllowAutoAttendantHolidayGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] + [-AllowAutoAttendantAfterHoursGreetingChange ] + [-AllowAutoAttendantHolidayGreetingChange ] + [-AllowAutoAttendantBusinessHoursChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantAfterHoursRoutingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] + [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] - [-AllowCallQueueWelcomeGreetingChange ] [-WhatIf] [-Confirm] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOverflowRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueNoAgentsRoutingChange ] + [-AllowCallQueueAgentOptChange ] + + [-CallQueueAgentMonitorMode ] + [-CallQueueAgentMonitorNotificationMode ] + + [-RealTimeAutoAttendantMetricsPermission ] + [-RealTimeCallQueueMetricsPermission ] + [-RealTimeAgentMetricsPermission ] + + [-HistoricalAutoAttendantMetricsPermission ] + [-HistoricalCallQueueMetricsPermission ] + [-HistoricalAgentMetricsPermission ] + + [-Description ] + [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows admins in the organization to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES ### EXAMPLE 1 + +```powershell +New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-CQ-Moh -AllowCallQueueMusicOnHoldChange $true ``` -New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-Moh -AllowCallQueueMusicOnHoldChange $true -``` -The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-Moh. This policy allows delegated administrators to change the music on hold information. + +The command shown in Example 1 creates a new per-user Teams voice applications policy with the Identity `SDA-Allow-Moh`. This policy allows delegated administrators to change the music on hold information. ### EXAMPLE 2 + +```powershell +New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-AA-After-Hour -AllowAutoAttendantAfterHoursGreetingChange $true ``` -New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-AA-After-Hour -AllowAutoAttendantAfterHoursGreetingChange $true -``` -The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity SDA-Allow-AA-After-Hour. This policy allows delegated administrators to change after-hours greetings for auto attendants. +The command shown in Example 2 creates a new per-user Teams voice applications policy with the Identity `SDA-Allow-AA-After-Hour`. This policy allows delegated administrators to change after-hours greetings for auto attendants. ## PARAMETERS ### -Identity + Unique identifier assigned to the policy when it was created. ```yaml @@ -58,8 +101,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange -This parameter allows supervisors and users to change auto attendants' after-hours greetings. +### -AllowAutoAttendantBusinessHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -73,8 +117,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange -This parameter allows supervisors and users to change auto attendants' business hours greetings. +### -AllowAutoAttendantAfterHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -89,7 +134,140 @@ Accept wildcard characters: False ``` ### -AllowAutoAttendantHolidayGreetingChange -This parameter allows supervisors and users to change auto attendants' holiday greetings. + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidaysChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantTimeZoneChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantAfterHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidayRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueWelcomeGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -104,7 +282,8 @@ Accept wildcard characters: False ``` ### -AllowCallQueueMusicOnHoldChange -This parameter allows supervisors and users to change call queue music on hold information. + +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -119,7 +298,8 @@ Accept wildcard characters: False ``` ### -AllowCallQueueOverflowSharedVoicemailGreetingChange -This parameter allows supervisors and users to change call queue overflow shared voicemail information (TTS or AudioFile). + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -134,7 +314,8 @@ Accept wildcard characters: False ``` ### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -148,8 +329,94 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange -This parameter allows supervisors and users to change the call queue's welcome greeting. +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange + +_This option is not currently available in Queues app._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueMembershipChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueConferenceModeChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueRoutingMethodChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueuePresenceBasedRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. + ```yaml Type: Boolean Parameter Sets: (All) @@ -162,7 +429,277 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowCallQueueOptOutChange + +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOverflowRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueTimeoutRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueNoAgentsRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueAgentOptChange + +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorMode + +PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. + +When set to `Monitor`, users affected by the policy will be allowed to monitor and listen to call sessions. + +When set to `Whisper`, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + +When set to `Barge`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + +When set to `Takeover`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorNotificationMode + +PARAMVALUE: Disabled | Agent + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. + +When set to `Agent`, users affected by the policy will be allowed to monitor agents during call sessions. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +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. @@ -179,6 +716,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -193,7 +731,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -201,16 +756,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) -[Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) - -[Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) - -[Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..e2f6188c48 --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,239 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy +title: New-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# New-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet creates a Teams Workload Policy instance for the tenant. + +## SYNTAX + +```powershell +New-CsTeamsWorkLoadPolicy [-Identity] [-AllowCalling ] [-AllowCallingPinned ] + [-AllowMeeting ] [-AllowMeetingPinned ] [-AllowMessaging ] + [-AllowMessagingPinned ] [-Description ] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> New-CsTeamsWorkLoadPolicy -Identity Test +``` + +Creates a new Teams Workload Policy with the specified identity of "Test". + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the Teams Workload policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..c99f3955de --- /dev/null +++ b/teams/teams-ps/teams/New-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy +title: New-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# New-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to create a new instance of the TeamsWorkLocationDetectionPolicy. The end user experience utilizing this policy has rolled out to the general public. You can see updates at [Microsoft 365 Roadmap | Microsoft 365](https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2Cset%2Cwork%2Clocation%22https://www.microsoft.com/en-us/microsoft-365/roadmap?msockid=287ab43847c06d0008cca05b46076c18&filters=&searchterms=automatically%2cset%2cwork%2clocation%22) and to learn more on how to enable the end user experience, please see [Setting up Bookable Desks in Microsoft Teams - Microsoft Teams | Microsoft Learn.](https://learn.microsoft.com/microsoftteams/rooms/bookable-desks) + +## SYNTAX + +``` +New-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection ] [-Identity] [-Force] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a new instance of the TeamsWorkLocationDetectionPolicy. This policy can be used to tailor the work location detection experience. The parameter `EnableWorkLocationDetection` allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy -EnableWorkLocationDetection $true +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy True +``` +Creates a new policy instance with the identity wld-enabled. `EnableWorkLocationDetection` is set to the value specified in the command. + +### Example 2 +```powershell +PS C:\> New-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy +``` +```output +Identity EnableWorkLocationDetection +-------- ---------------------- +Tag:wld-policy False +``` +Creates a new policy instance with the identity wld-policy. `EnableWorkLocationDetection` will default to false if it is not specified. + +## 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 +``` + +### -EnableWorkLocationDetection +This setting allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 + +### System.String + +## OUTPUTS + +### TeamsWorkLocationDetectionPolicy.Cmdlets.TeamsWorkLocationDetectionPolicy + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/skype/skype-ps/skype/New-CsTenantDialPlan.md b/teams/teams-ps/teams/New-CsTenantDialPlan.md similarity index 52% rename from skype/skype-ps/skype/New-CsTenantDialPlan.md rename to teams/teams-ps/teams/New-CsTenantDialPlan.md index 4d269606ed..3496d58772 100644 --- a/skype/skype-ps/skype/New-CsTenantDialPlan.md +++ b/teams/teams-ps/teams/New-CsTenantDialPlan.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstenantdialplan -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan +applicable: Microsoft Teams title: New-CsTenantDialPlan schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,18 +18,16 @@ Use the `New-CsTenantDialPlan` cmdlet to create a new tenant dial plan. ## SYNTAX ``` -New-CsTenantDialPlan [-Tenant ] [-Description ] [-NormalizationRules ] - [-ExternalAccessPrefix ] [-SimpleName ] [-OptimizeDeviceDialing ] - [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +New-CsTenantDialPlan [-Identity] [-Description ] [-NormalizationRules ] + [-SimpleName ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -You can use this cmdlet to create a new tenant dial plan. -Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. +You can use this cmdlet to create a new tenant dial plan. Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. +A tenant dial plan determines such things as which normalization rules are applied. -You can add new normalization rules to a tenant dial plan by calling the [New-CsVoiceNormalizationRule](https://docs.microsoft.com/powershell/module/skype/New-CsVoiceNormalizationRule) cmdlet. +You can add new normalization rules to a tenant dial plan by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet. ## EXAMPLES @@ -40,17 +38,14 @@ New-CsTenantDialPlan -Identity vt1tenantDialPlan9 This example creates a tenant dial plan that has an Identity of vt1tenantDialPlan9. - ### -------------------------- Example 2 -------------------------- ``` $nr2 = New-CsVoiceNormalizationRule -Identity Global/NR2 -Description "TestNR1" -Pattern '^(d{11})$' -Translation '+1' -InMemory - New-CsTenantDialPlan -Identity vt1tenantDialPlan91 -NormalizationRules @{Add=$nr2} ``` This example creates a new normalization rule and then applies that rule to a new tenant dial plan. - ## PARAMETERS ### -Identity @@ -60,13 +55,13 @@ Valid characters are alphabetic or numeric characters, hyphen (-) and dot (.). The value should not begin with a (.) ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -79,7 +74,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -95,62 +90,8 @@ Maximum characters: 1040. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalAccessPrefix -The ExternalAccessPrefix parameter is a number (or set of numbers) that designates the call as external to the organization. -(For example, to tenant-dial an outside line, first press 9.) This prefix is ignored by the normalization rules, although these rules are applied to the remainder of the number. - -The OptimizeDeviceDialing parameter must be set to True for this value to take effect. -The value of this parameter must be no longer than 4 characters long and can contain only digits, "#" or a "*". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -The InMemory parameter creates an object reference without actually committing the object as a permanent change. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -161,19 +102,19 @@ Accept wildcard characters: False ### -NormalizationRules The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) cmdlet. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) cmdlet. Each time a new tenant dial plan is created, a new voice normalization rule with default settings is also created for that site, service, or per-user tenant dial plan. By default, the Identity of the new voice normalization rule is the tenant dial plan Identity followed by a slash and then followed by the name Prefix All. (For example, TAG:Redmond/Prefix All.) The number of normalization rules cannot exceed 50 per TenantDialPlan. -You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) cmdlet. +You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet. ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -182,23 +123,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OptimizeDeviceDialing -Use this parameter to determine the effect of ExternalAccessPrefix parameter. -If set to True, the ExternalAccessPrefix parameter takes effect. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SimpleName The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. @@ -212,26 +136,8 @@ However, if you don't provide a value, a default value matching the Identity of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -248,7 +154,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -258,13 +164,22 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. ## RELATED LINKS +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-CsTenantNetworkRegion.md b/teams/teams-ps/teams/New-CsTenantNetworkRegion.md new file mode 100644 index 0000000000..33bb7d2c2d --- /dev/null +++ b/teams/teams-ps/teams/New-CsTenantNetworkRegion.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion +applicable: Microsoft Teams +title: New-CsTenantNetworkRegion +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# New-CsTenantNetworkRegion + +## SYNOPSIS +As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + +## SYNTAX + +### Identity (Default) +``` +New-CsTenantNetworkRegion [-Identity] [-BypassID ] [-CentralSite ] + [-Description ] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsTenantNetworkRegion -NetworkRegionID [-BypassID ] [-CentralSite ] +[-Description ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> New-CsTenantNetworkRegion -NetworkRegionID "RegionA" +``` + +The command shown in Example 1 creates the network region 'RegionA' with no description. Identity and CentralSite will both be set identically to NetworkRegionID. + +## PARAMETERS + +### -Identity +Unique identifier for the network region to be created. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BypassID +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CentralSite +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network region to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRegionID +The name of the network region. This must be a string that is unique. You cannot specify an NetworkRegionID and an Identity at the same time. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) + +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) + +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) diff --git a/skype/skype-ps/skype/New-CsTenantNetworkSite.md b/teams/teams-ps/teams/New-CsTenantNetworkSite.md similarity index 53% rename from skype/skype-ps/skype/New-CsTenantNetworkSite.md rename to teams/teams-ps/teams/New-CsTenantNetworkSite.md index 8b3e56b514..81412644a9 100644 --- a/skype/skype-ps/skype/New-CsTenantNetworkSite.md +++ b/teams/teams-ps/teams/New-CsTenantNetworkSite.md @@ -1,36 +1,36 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstenantnetworksite -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite +applicable: Microsoft Teams title: New-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # New-CsTenantNetworkSite ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, New-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. Tenant network site is used for Location Based Routing. +As an admin, you can use the Teams PowerShell command, New-CsTenantNetworkSite to define network sites. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. The organization's network site is used for Location-Based Routing. ## SYNTAX ### Identity (Default) ``` -New-CsTenantNetworkSite [-Tenant ] [-Description ] [-NetworkRegionID ] - [-LocationPolicy ] [-EnableLocationBasedRouting ] [-EmergencyCallRoutingPolicy ] [-EmergencyCallingPolicy ] [-NetworkRoamingPolicy ] [-OnlineVoiceRoutingPolicy ] - [-SiteAddress ] [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] - [] +New-CsTenantNetworkSite [-Identity] [-Description ] [-EmergencyCallingPolicy ] + [-EmergencyCallRoutingPolicy ] [-EnableLocationBasedRouting ] [-LocationPolicy ] + [-NetworkRegionID ] [-NetworkRoamingPolicy ] [-SiteAddress ] + [-WhatIf] [-Confirm] [] ``` ### ParentAndRelativeKey ``` -New-CsTenantNetworkSite [-Tenant ] -NetworkSiteID [-Description ] - [-NetworkRegionID ] [-LocationPolicy ] [-EnableLocationBasedRouting ] - [-EmergencyCallRoutingPolicy ] [-NetworkRoamingPolicy ] [-EmergencyCallingPolicy ] [-OnlineVoiceRoutingPolicy ] [-SiteAddress ] [-InMemory] [-Force] [-WhatIf] [-Confirm] - [] +New-CsTenantNetworkSite -NetworkSiteID [-Description ] [-EmergencyCallingPolicy ] + [-EmergencyCallRoutingPolicy ] [-EnableLocationBasedRouting ] [-LocationPolicy ] + [-NetworkRegionID ] [-NetworkRoamingPolicy ] [-SiteAddress ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,7 +40,7 @@ A best practice for Location Based Routing (LBR) is to create a separate site fo ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> New-CsTenantNetworkSite -NetworkSiteID "MicrosoftSite1" -NetworkRegionID "RegionRedmond" ``` @@ -51,31 +51,31 @@ The network region 'RegionRedmond' is created beforehand and 'MicrosoftSite1' wi NetworkSites can exist without all parameters excepts NetworkSiteID. NetworkRegionID can be left blank. -###-------------------------- Example 2 -------------------------- +### Example 2 ```powershell -PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site2" -Description "site 2" -NetworkRegionID "RedmondRegion" -LocationPolicy "TestLocationPolicy" -EnableLocationBasedRouting $true -SiteAddress "One Microsoft way" -OnlineVoiceRoutingPolicy "OVRP1" +PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site2" -Description "site 2" -NetworkRegionID "RedmondRegion" -LocationPolicy "TestLocationPolicy" -EnableLocationBasedRouting $true ``` -The command shown in Example 2 created the network site 'site2' with description 'site 2'. This site is enabled for LBR, and associates with network region 'RedmondRegion', with location policy 'TestLocationPolicy', and with OnlineVoiceRoutingPolicy "OVRP1" +The command shown in Example 2 creates the network site 'site2' with the description 'site 2'. This site is enabled for LBR, and associates with network region 'RedmondRegion' and with location policy 'TestLocationPolicy'. -###-------------------------- Example 3 -------------------------- +### Example 3 ```powershell PS C:\> New-CsTenantNetworkSite -NetworkSiteID "site3" -Description "site 3" -NetworkRegionID "RedmondRegion" -NetworkRoamingPolicy "TestNetworkRoamingPolicy" ``` -The command shown in Example 3 created the network site 'site3' with description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. +The command shown in Example 3 creates the network site 'site3' with the description 'site 3'. This site is enabled for network roaming capabilities. The example associates the site with network region 'RedmondRegion' and network roaming policy 'TestNetworkRoamingPolicy'. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network site to be created. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: String +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -96,23 +96,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -This parameter determines whether the current site is enabled for location based routing. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -EmergencyCallRoutingPolicy -This parameter is used to assign a custom emergency call routing policy to a network site. For more information see [Assign a custom emergency call routing policy to a network site](https://docs.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). +This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). ```yaml Type: String @@ -127,7 +112,7 @@ Accept wildcard characters: False ``` ### -EmergencyCallingPolicy -This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://docs.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). +This parameter is used to assign a custom emergency calling policy to a network site. For more information see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). ```yaml Type: String @@ -141,26 +126,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRoamingPolicy -NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -EnableLocationBasedRouting +This parameter determines whether the current site is enabled for Location-Based Routing. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -171,26 +141,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier for the network site to be created. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -PARAMVALUE: SwitchParameter +### -LocationPolicy +This parameter is reserved for Microsoft internal use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -201,8 +156,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -LocationPolicy is the identifier for the location policy which the current network site is associating to. +### -NetworkRegionID +NetworkRegionID is the identifier for the network region to which the current network site is associated to. ```yaml Type: String @@ -216,8 +171,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -NetworkRegionID is the identifier for the network region which the current network site is associating to. +### -NetworkRoamingPolicy +NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. ```yaml Type: String @@ -246,25 +201,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnlineVoiceRoutingPolicy -This parameter determines the unique name of existing OnlineVoiceRoutingPolicy that the current network site associates to. - -OnlineVoiceRoutingPolicy is used to associate a user with the appropriate PSTN usages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SiteAddress -The address of current network site. +This parameter is not used. ```yaml Type: String @@ -278,19 +216,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network sites are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -316,16 +248,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES ## RELATED LINKS +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) + +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) + +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) diff --git a/skype/skype-ps/skype/New-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md similarity index 68% rename from skype/skype-ps/skype/New-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/New-CsTenantNetworkSubnet.md index 08fe42909b..0639975119 100644 --- a/skype/skype-ps/skype/New-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/teams/New-CsTenantNetworkSubnet.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-cstenantnetworksubnet -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet +applicable: Microsoft Teams title: New-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,15 +19,14 @@ As an Admin, you can use the Windows PowerShell command, New-CsTenantNetworkSubn ### Identity (Default) ``` -New-CsTenantNetworkSubnet [-Tenant ] [-Description ] -NetworkSiteID - -MaskBits [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] - [] +New-CsTenantNetworkSubnet [-Identity] -MaskBits [-Description ] + [-NetworkSiteID ] [-WhatIf] [-Confirm] [] ``` ### ParentAndRelativeKey ``` -New-CsTenantNetworkSubnet [-Tenant ] -SubnetID [-Description ] - -NetworkSiteID -MaskBits [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +New-CsTenantNetworkSubnet -MaskBits -SubnetID [-Description ] + [-NetworkSiteID ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,7 +36,7 @@ When the client is sending the network subnet, please make sure we have already ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> New-CsTenantNetworkSubnet -SubnetID "192.168.0.1" -MaskBits "24" -NetworkSiteID "site1" ``` @@ -46,7 +45,7 @@ The command shown in Example 1 created the network subnet '192.168.0.1' with no IPv4 format subnet accepts maskbits from 0 to 32 inclusive. -###-------------------------- Example 2 -------------------------- +### Example 2 ```powershell PS C:\> New-CsTenantNetworkSubnet -SubnetID "2001:4898:e8:25:844e:926f:85ad:dd8e" -MaskBits "120" -NetworkSiteID "site1" ``` @@ -57,56 +56,11 @@ IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ## 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 -``` - -### -Description -Provide a description of the network subnet to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the network subnet to be created. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: @@ -117,32 +71,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -PARAMVALUE: SwitchParameter +### -MaskBits +This parameter determines the length of bits to mask to the subnet. + +IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskBits -This parameter determines the length of bits to mask to the subnet. - -IPv4 format subnet accepts maskbits from 0 to 32 inclusive. IPv6 format subnet accepts maskbits from 0 to 128 inclusive. +### -Description +Provide a description of the network subnet to identify the purpose of creating it. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -179,19 +133,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network subnets are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -217,8 +165,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -226,7 +173,11 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS -### System.Object ## NOTES ## RELATED LINKS +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) + +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) + +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) diff --git a/skype/skype-ps/skype/New-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md similarity index 95% rename from skype/skype-ps/skype/New-CsTenantTrustedIPAddress.md rename to teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md index d14083cf73..95772cba10 100644 --- a/skype/skype-ps/skype/New-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/teams/New-CsTenantTrustedIPAddress.md @@ -1,11 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: tmp_rf3olqzj.wbj +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenanttrustedipaddress +title: New-CsTenantTrustedIPAddress schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: --- # New-CsTenantTrustedIPAddress @@ -208,8 +210,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -218,6 +219,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/New-CsUserCallingDelegate.md b/teams/teams-ps/teams/New-CsUserCallingDelegate.md index f130f15e9b..bcb61efbcc 100644 --- a/teams/teams-ps/teams/New-CsUserCallingDelegate.md +++ b/teams/teams-ps/teams/New-CsUserCallingDelegate.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-csusercallingdelegate +online version: https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: New-CsUserCallingDelegate schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # New-CsUserCallingDelegate @@ -129,8 +130,8 @@ The specified user need to have the Microsoft Phone System license assigned. You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. ## RELATED LINKS -[Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) -[Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) -[Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md similarity index 87% rename from skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md index 5c787a93d6..06ece90114 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/new-csvideointeropserviceprovider -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/new-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: New-CsVideoInteropServiceProvider schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsVideoInteropServiceProvider @@ -51,7 +51,7 @@ PS C:\> New-CsVideoInteropServiceProvider ## PARAMETERS ### -AadApplicationIds -This is an optional parameter. A semicolon separated list of AAD AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. +This is an optional parameter. A semicolon separated list of Microsoft Entra AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. ```yaml Type: String @@ -67,7 +67,7 @@ Accept wildcard characters: False ### -AllowAppGuestJoinsAsAuthenticated This is an optional parameter. Default = false. -This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots AAD application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. +This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots Microsoft Entra application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. ```yaml Type: Boolean @@ -116,7 +116,7 @@ This is mandatory parameter and can have only one of the 6 values PolycomServiceProviderEnabled PexipServiceProviderEnabled BlueJeansServiceProviderEnabled - + PolycomServiceProviderDisabled PexipServiceProviderDisabled BlueJeansServiceProviderDisabled @@ -230,14 +230,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md b/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md new file mode 100644 index 0000000000..50a147a31f --- /dev/null +++ b/teams/teams-ps/teams/New-CsVoiceNormalizationRule.md @@ -0,0 +1,372 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule +applicable: Microsoft Teams +title: New-CsVoiceNormalizationRule +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +--- + +# New-CsVoiceNormalizationRule + +## SYNOPSIS +Creates a new voice normalization rule. + +Voice normalization rules are used to convert a telephone dialing requirement (for example, dialing 9 to access an outside line) to the E.164 phone number format used by +Skype for Business Server or Microsoft Teams. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +New-CsVoiceNormalizationRule [-Tenant ] [-Description ] [-Pattern ] + [-Translation ] [-IsInternalExtension ] [-Priority ] [-Identity] + [-InMemory] [-Force] [-WhatIf] [-Confirm] [] +``` + +### ParentAndRelativeKey +``` +New-CsVoiceNormalizationRule [-Tenant ] -Parent -Name [-Description ] + [-Pattern ] [-Translation ] [-IsInternalExtension ] [-Priority ] [-InMemory] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet creates a named voice normalization rule. +These rules are a required part of phone authorization and call routing. +They define the requirements for converting (or translating) numbers from an internal format to a standard (E.164) format. +An understanding of regular expressions is helpful in order to define number patterns that will be translated. + +For Lync or Skype for Business Server, rules that are created by using this cmdlet are part of the dial plan and in addition to being accessible through the +`Get-CsVoiceNormalizationRule` cmdlet can also be accessed through the NormalizationRules property returned by a call to the `Get-CsDialPlan` cmdlet. +You cannot create a normalization rule unless a dial plan with an Identity matching the scope specified in the normalization rule Identity already exists. +For example, you can't create a normalization rule with the Identity site:Redmond/RedmondNormalizationRule unless a dial plan for site:Redmond already exists. + +For Microsoft Teams, rules that are created by using this cmdlet can only be created with the InMemory switch and should be added to a tenant dial plan using +the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" +``` + +This example creates a new voice normalization rule for site Redmond named Prefix Redmond. +Because no other parameters are specified, the rule is created with the default values. +Notice that the value passed to the Identity parameter is in double quotes; this is because the name of the rule (Prefix Redmond) contains a space. +If the rule name does not contain a space you don't need to enclose the Identity in double quotes. + +Keep in mind that a dial plan for the Redmond site must exist for this command to succeed. +You can create a new dial plan by calling the `New-CsDialPlan` cmdlet. + +### -------------------------- Example 2 -------------------------- +``` +New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' +``` + +This example creates a new voice normalization rule named SeattleFourDigit that applies to the per-user dial plan with the Identity SeattleUser. +(Note: Rather than specifying a Parent and a Name, we could have instead created this same rule by specifying -Identity SeattleUser/SeattleFourDigit.) We've included a Description explaining that this rule is for translating numbers dialed internally with only a 4-digit extension. +In addition, Pattern and Translation values have been specified. +These values translate a four-digit number (specified by the regular expression in the Pattern) to the same four-digit number, but prefixed by the Translation value (+1206555). +For example, if the extension 1234 was entered, this rule would translate that extension to the number +12065551234. + +Note the single quotes around the Pattern and Translation values. +Single quotes are required for these values; double quotes (or no quotes) will not work in this instance. + +As in Example 1, a dial plan with the given scope must exist. +In this case, that means a dial plan with the Identity SeattleUser must already exist. + +### -------------------------- Example 3 -------------------------- +``` +$nr1=New-CsVoiceNormalizationRule -Identity dp1/nr1 -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' -InMemory +New-CsTenantDialPlan -Identity DP1 -NormalizationRules @{Add=$nr1} +``` + +This example creates a new in-memory voice normalization rule and then adds it to a new tenant dial plan DP1 to be used for Microsoft Teams users. + +## PARAMETERS + +### -Identity +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +The name portion will automatically be stored in the Name property. +You cannot specify values for Identity and Name in the same command. + +For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. +A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. +(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) + +For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. + +The Identity parameter is required unless the Parent parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule. +This parameter is required if a value has been specified for the Parent parameter. +If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. +For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. +The Name parameter and the Identity parameter cannot be used in the same command. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent +The scope at which the new normalization rule will be created. +This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as +PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. +A dial plan with the specified scope must already exist or the command will fail. + +The Parent parameter is required unless the Identity parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. +If you include the Parent parameter, the Name parameter is also required. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A friendly description of the normalization rule. + +Maximum string length: 512 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsInternalExtension +If True, the result of applying this rule will be a number internal to the organization. +If False, applying the rule results in an external number. +This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. + +Default: False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the dialed number must match in order for this rule to be applied. + +Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The order in which rules are applied. +A phone number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Translation +The regular expression pattern that will be applied to the number to convert it to E.164 format. + +Default: +$1 (The default prefixes the number with a plus sign \[+\].) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory +Creates an object reference without actually committing the object as a permanent change. + +For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the +object reference and then commit those changes by calling this cmdlet's matching Set-\. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +For internal Microsoft usage. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business 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/?LinkID=113216). + +## INPUTS + +### Input types +None. + +## OUTPUTS + +### Output types +This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule. + +## NOTES + +## RELATED LINKS + +[Test-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule) + +[Get-CsDialPlan](https://learn.microsoft.com/powershell/module/teams/get-csdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) diff --git a/teams/teams-ps/teams/New-Team.md b/teams/teams-ps/teams/New-Team.md index 0afbd41945..5ca7ae7b5c 100644 --- a/teams/teams-ps/teams/New-Team.md +++ b/teams/teams-ps/teams/New-Team.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-team +online version: https://learn.microsoft.com/powershell/module/teams/new-team +title: New-Team schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -11,16 +12,13 @@ ms.reviewer: # New-Team ## SYNOPSIS -This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. -Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. - -If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://docs.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). +This cmdlet lets you provision a new Team for use in Microsoft Teams and will create an O365 Unified Group to back the team. +Groups created through teams cmdlets, APIs, or clients will not show up in Outlook by default. +If you want these groups to appear in Outlook clients, you can use the [Set-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/set-unifiedgroup) cmdlet in the Exchange Powershell Module to disable the switch parameter `HiddenFromExchangeClientsEnabled` (-HiddenFromExchangeClientsEnabled:$false). Note: The Teams application may need to be open by an Owner for up to two hours before changes are reflected. - - ## SYNTAX ### CreateTeam (Default) @@ -32,8 +30,8 @@ New-Team -DisplayName [-Description ] [-MailNickName ] [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] [-AllowAddRemoveApps ] [-AllowCreateUpdateRemoveTabs ] [-AllowCreateUpdateRemoveConnectors ] [-AllowUserEditMessages ] [-AllowUserDeleteMessages ] [-AllowOwnerDeleteMessages ] - [-AllowTeamMentions ] [-AllowChannelMentions ] [-ShowInTeamsSearchAndSuggestions ] - [-RetainCreatedGroup ] [] + [-AllowTeamMentions ] [-AllowChannelMentions ] [-ShowInTeamsSearchAndSuggestions ] + [-RetainCreatedGroup ] [-AllowCreatePrivateChannels ] [] ``` ### MigrateGroup @@ -87,7 +85,7 @@ This value will be used for the mail enabled object and will be used as PrimaryS The value of the MailNickName parameter has to be unique across your tenant. Note: If Microsoft 365 groups naming policies are enabled in your tenant, this parameter is required and must also comply with the naming policy. -For more details about the naming conventions see here: [New-UnifiedGroup](https://docs.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. +For more details about the naming conventions see here: [New-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup#parameters), Parameter: -Alias. ```yaml Type: String @@ -165,8 +163,8 @@ Accept wildcard characters: False ``` ### -Owner -An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. -This user will be added as both a member and an owner of the group. +An admin who is allowed to create on behalf of another user should use this flag to specify the desired owner of the group. +This user will be added as both a member and an owner of the group. If not specified, the user who creates the team will be added as both a member and an owner. Please note: This parameter is mandatory, if connected using Certificate Based Authentication. @@ -424,7 +422,7 @@ Accept wildcard characters: False ### -GroupId Specify a GroupId to convert to a Team. If specified, you cannot provide the other values that are already specified by the existing group, namely: Visibility, Alias, Description, or DisplayName. -If, for example, you need to create a Team from an existing Microsoft 365 Group, use the _ExternalDirectoryObjectId_ property value returned by [Get-UnifiedGroup](https://docs.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). +If, for example, you need to create a Team from an existing Microsoft 365 Group, use the _ExternalDirectoryObjectId_ property value returned by [Get-UnifiedGroup](https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup?view=exchange-ps). ```yaml Type: String @@ -483,9 +481,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. + +```yaml +Type: Boolean +Parameter Sets: CreateTeam +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -497,8 +509,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Remove-Team](remove-team.md) +[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) -[Get-Team](get-team.md) +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[Set-Team](set-team.md) +[Set-Team](https://learn.microsoft.com/powershell/module/teams/set-team) diff --git a/teams/teams-ps/teams/New-TeamChannel.md b/teams/teams-ps/teams/New-TeamChannel.md index f10199dd29..579b2c7209 100644 --- a/teams/teams-ps/teams/New-TeamChannel.md +++ b/teams/teams-ps/teams/New-TeamChannel.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-teamchannel +online version: https://learn.microsoft.com/powershell/module/teams/new-teamchannel +title: New-TeamChannel schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -88,7 +89,7 @@ Accept wildcard characters: False ``` ### -MembershipType -Channel membership type, Standard or Private. +Channel membership type, Standard, Shared, or Private. ```yaml Type: String @@ -118,10 +119,10 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS + ### GroupId, DisplayName, Description, MembershipType, Owner ## OUTPUTS diff --git a/teams/teams-ps/teams/New-TeamsApp.md b/teams/teams-ps/teams/New-TeamsApp.md index 1d7ce6523e..1ba731d7b5 100644 --- a/teams/teams-ps/teams/New-TeamsApp.md +++ b/teams/teams-ps/teams/New-TeamsApp.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/new-teamsapp +online version: https://learn.microsoft.com/powershell/module/teams/new-teamsapp +title: New-TeamsApp schema: 2.0.0 --- @@ -59,14 +60,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md similarity index 60% rename from skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md index 33c486abb5..e2c1985c62 100644 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/register-csonlinedialinconferencingservicenumber -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/register-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams title: Register-CsOnlineDialInConferencingServiceNumber schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Register-CsOnlineDialInConferencingServiceNumber ## SYNOPSIS -Provide the topic introduction here. +When you buy Audio Conferencing licenses, Microsoft is hosting your audio conferencing bridge for your organization. The audio conferencing bridge gives out dial-in phone numbers from different locations so that meeting organizers and participants can use them to join Microsoft Teams meetings using a phone. +In addition to the phone numbers already assigned to your conferencing bridge, you can get additional service numbers (toll and toll-free numbers used for audio conferencing) from other locations, and then assign them to the conferencing bridge so you can expand coverage for your users. The Register-CsOnlineDialInConferencingServiceNumber command allows you to assign any additional service number that you may have acquired to your conference bridge. ## SYNTAX @@ -32,17 +33,16 @@ Register-CsOnlineDialInConferencingServiceNumber [-Instance] ] [] +``` + +## DESCRIPTION + +This cmdlet deletes an existing application access policy. + +## EXAMPLES + +### Remove an application access policy + +``` +PS C:\> Remove-CsApplicationAccessPolicy -Identity "ASimplePolicy" +``` + +The command shown above deletes the application access policy ASimplePolicy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Set-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) diff --git a/skype/skype-ps/skype/Remove-CsAutoAttendant.md b/teams/teams-ps/teams/Remove-CsAutoAttendant.md similarity index 63% rename from skype/skype-ps/skype/Remove-CsAutoAttendant.md rename to teams/teams-ps/teams/Remove-CsAutoAttendant.md index 7bb2dc782f..a847c6ab1f 100644 --- a/skype/skype-ps/skype/Remove-CsAutoAttendant.md +++ b/teams/teams-ps/teams/Remove-CsAutoAttendant.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csautoattendant -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant +applicable: Microsoft Teams title: Remove-CsAutoAttendant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsAutoAttendant @@ -16,8 +16,7 @@ ms.reviewer: Use the Remove-CsAutoAttendant cmdlet to delete an Auto Attendant (AA). > [!NOTE] -> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) before attempting to delete the Auto Attendant (AA). - +> Remove any associated resource accounts with [Remove-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation) before attempting to delete the Auto Attendant (AA). ## SYNTAX @@ -35,20 +34,18 @@ The Remove-CsAutoAttendant cmdlet deletes an AA that is specified by the Identit Remove-CsAutoAttendant -Identity "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` -This example deletes the AA that has a identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. - +This example deletes the AA that has an identity of fa9081d6-b4f3-5c96-baec-0b00077709e5. ## PARAMETERS ### -Identity The identity for the AA to be removed. - ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -63,7 +60,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -73,25 +70,23 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### String The Remove-CsAutoAttendant cmdlet accepts a string as the Identity parameter. - ## OUTPUTS ### None - ## NOTES ## RELATED LINKS -[New-CsAutoAttendant](New-CsAutoAttendant.md) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) -[Get-CsAutoAttendant](Get-CsAutoAttendant.md) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) -[Set-CsAutoAttendant](Set-CsAutoAttendant.md) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) diff --git a/skype/skype-ps/skype/Remove-CsCallQueue.md b/teams/teams-ps/teams/Remove-CsCallQueue.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsCallQueue.md rename to teams/teams-ps/teams/Remove-CsCallQueue.md index ba0c7a26eb..b4138debb8 100644 --- a/skype/skype-ps/skype/Remove-CsCallQueue.md +++ b/teams/teams-ps/teams/Remove-CsCallQueue.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscallqueue -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallqueue +applicable: Microsoft Teams title: Remove-CsCallQueue schema: 2.0.0 ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Remove-CsCallQueue @@ -33,7 +34,6 @@ Remove-CsCallQueue -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 This example removes the Call Queue with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Call Queue exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. - ## PARAMETERS ### -Identity @@ -42,8 +42,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -58,8 +58,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -69,19 +69,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Identity Represents the unique identifier of a Call Queue. - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsCallingLineIdentity.md b/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md similarity index 70% rename from skype/skype-ps/skype/Remove-CsCallingLineIdentity.md rename to teams/teams-ps/teams/Remove-CsCallingLineIdentity.md index 776087ffe2..0a95b6cbed 100644 --- a/skype/skype-ps/skype/Remove-CsCallingLineIdentity.md +++ b/teams/teams-ps/teams/Remove-CsCallingLineIdentity.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cscallinglineidentity -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity +applicable: Microsoft Teams title: Remove-CsCallingLineIdentity schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -33,7 +33,6 @@ PS C:\> Remove-CsCallingLineIdentity -Identity Anonymous This example removes a Caller ID policy. - ## PARAMETERS ### -Identity @@ -42,8 +41,8 @@ The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: 1 @@ -59,7 +58,7 @@ The WhatIf switch causes the command to simulate its results. By using this swit Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -75,7 +74,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -85,7 +84,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -95,10 +94,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) -[New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) -[Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +[Set-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..8d0edf2cca --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: Remove-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +Remove-CsComplianceRecordingForCallQueueTemplate -Id [] +``` + +## DESCRIPTION +Use the Remove-CsComplianceRecordingForCallQueueTemplate cmdlet to delete a Compliance Recording for Call Queues template. If the template is currently assigned to a call queue, an error will be returned. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example deletes the Compliance Recording for Call Queue template with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Compliance Recording for Call Queue template exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Id +The Id parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md b/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md index ffa78b5ed9..c5fbbf878d 100644 --- a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md +++ b/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md @@ -5,7 +5,7 @@ title: Remove-CsCustomPolicyPackage author: sunguchuan ms.author: gucsun manager: dasosby -online version: https://docs.microsoft.com/powershell/module/teams/remove-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage schema: 2.0.0 --- @@ -64,8 +64,8 @@ Default packages created by Microsoft cannot be deleted. ## RELATED LINKS -[Get-CsPolicyPackage](Get-CsPolicyPackage.md) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) -[New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) -[Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +[Update-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..a801caa0bb --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsExternalAccessPolicy.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy +applicable: Microsoft Teams +title: Remove-CsExternalAccessPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Remove-CsExternalAccessPolicy + +## SYNOPSIS +Enables you to remove an existing external access policy. +External access policies determine whether or not your users can: 1) Communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) Communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Windows Live; 3) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop) and 4) Access Skype for Business Server over the Internet, without having to log on to your internal network. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +``` +Remove-CsExternalAccessPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with other people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +1. That might be sufficient to meet your communication needs. +If it doesn't meet your needs you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +2. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +3. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). This policy setting only applies if ACS federation has been enabled at the tenant level using the cmdlet [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration). + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Windows Live. + +Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +When you install Skype for Business Server, a global external access policy is automatically created for you. +In addition to the global policy, you can use the `New-CsExternalAccessPolicy` cmdlet to create external access policies configured at the site or per-user scopes. + +The `Remove-CsExternalAccessPolicy` cmdlet enables you to delete any policies that were created by using the `New-CsExternalAccessPolicy` cmdlet; that means you can delete any policies assigned to the site scope or the per-user scope. +You can also run the `Remove-CsExternalAccessPolicy` cmdlet against the global external access policy. +In that case, however, the global policies will not be deleted; by design, global policies cannot be deleted. +Instead, the properties of the global policy will simply be reset to their default values. + +## EXAMPLES + +### -------------------------- Example 1 ------------------------ +``` +Remove-CsExternalAccessPolicy -Identity site:Redmond +``` + +In Example 1, the external access policy with the Identity site:Redmond is deleted. +After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. + +### -------------------------- Example 2 ------------------------ +``` +Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy +``` + +Example 2 deletes all the external access policies that have been configured at the site scope. +To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". +The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. + +### -------------------------- Example 3 ------------------------ +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy +``` + +In Example 3, all the external access policies that allow federation access are deleted. +To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to return a collection of all the external access policies configured for use in the organization. +This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. +This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. + +### -------------------------- Example 4 ------------------------ +``` +Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy +``` + +Example 4 deletes all the external access policies that meet at least one of two criteria: federation access is allowed, public cloud access is allowed, or both are allowed. +To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet to return a collection of all the external access policies configured for use in the organization. +This collection is then piped to the `Where-Object` cmdlet, which selects only those policies that meet the following criteria: either EnableFederationAccess is equal to True and/or EnablePublicCloudAccess is equal to True. +Policies meeting one (or both) of those criteria are then piped to and removed by, the `Remove-CsExternalAccessPolicy` cmdlet. + +To delete all the policies where both EnableFederationAccess and EnablePublicCloudAccess are True use the -and operator when calling the `Where-Object` cmdlet: + +`Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True}` + +## PARAMETERS + +### -Identity +Unique identifier for the external access policy to be removed. +External access policies can be configured at the global, site, or per-user scopes. +To "remove" the global policy, use this syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. +Instead, all the properties in the global policy will be reset to their default values.) To remove a site policy, use syntax similar to this: `-Identity site:Redmond`. +To remove a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. + +Note that wildcards are not allowed when specifying an Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being removed. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +The `Remove-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. + +## OUTPUTS + +### Output types +None. +Instead, the `Remove-CsExternalAccessPolicy` cmdlet does not return a value or object. +Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md index 1dc106a05c..db975cb1bc 100644 --- a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment +online version: https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment +title: Remove-CsGroupPolicyAssignment schema: 2.0.0 author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsGroupPolicyAssignment @@ -39,7 +40,7 @@ d8ebfa45-0f28-4d2d-9bcc-b158a49e2d17 TeamsMeetingPolicy AllOn 1 10/29/20 e050ce51-54bc-45b7-b3e6-c00343d31274 TeamsMeetingPolicy AllOff 2 11/2/2019 12:20:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 566b8d39-5c5c-4aaa-bc07-4f36278a1b38 TeamsMeetingPolicy Kiosk 3 11/2/2019 12:14:41 AM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 -Remove-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingPolicy +Remove-CsGroupPolicyAssignment -GroupId e050ce51-54bc-45b7-b3e6-c00343d31274 -PolicyType TeamsMeetingPolicy Get-CsGroupPolicyAssignment -PolicyType TeamsMeetingPolicy @@ -220,8 +221,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -231,9 +231,8 @@ For more information, see [About CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) -[Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) - -[Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) +[Set-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment) diff --git a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md index 2f4a0fca40..d08b9fba67 100644 --- a/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/teams/Remove-CsHybridTelephoneNumber.md @@ -1,116 +1,122 @@ ---- -external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml -Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber -applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Remove-CsHybridTelephoneNumber - -## SYNOPSIS -This cmdlet removes a hybrid telephone number. - -## SYNTAX - -### Identity (Default) -```powershell -Remove-CsHybridTelephoneNumber -TelephoneNumber [-Force] [-WhatIf] [-Confirm][] -``` - -## DESCRIPTION -This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 -``` -This example removes the hybrid phone number +1 (402) 555-1234. - -## PARAMETERS - -### -TelephoneNumber -The telephone number to remove. The number should be specified without a prefixed "+". The phone number can not have "tel:" prefixed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -### None - -## NOTES - -The cmdlet is only available in GCC High and DoD cloud instances. - -## RELATED LINKS -[New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) - -[Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +--- +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-cshybridtelephonenumber +applicable: Microsoft Teams +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +title: Remove-CsHybridTelephoneNumber +schema: 2.0.0 +--- + +# Remove-CsHybridTelephoneNumber + +## SYNOPSIS +This cmdlet removes a hybrid telephone number. + +> [!IMPORTANT] +> This cmdlet is being deprecated. Use the new **New-CsOnlineTelephoneNumberReleaseOrder** cmdlet to remove a telephone number for Audio Conferencing with Direct Routing in Microsoft 365 GCC High and DoD clouds. Detailed instructions on how to use the new cmdlet can be found at [New-CsOnlineTelephoneNumberReleaseOrder](/powershell/module/teams/new-csonlinetelephonenumberreleaseorder?view=teams-ps). + +## SYNTAX + +### Identity (Default) +```powershell +Remove-CsHybridTelephoneNumber -TelephoneNumber [-Force] [-WhatIf] [-Confirm][] +``` + +## DESCRIPTION +This cmdlet removes a hybrid telephone number used for Audio Conferencing with Direct Routing for GCC High and DoD clouds. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsHybridTelephoneNumber -TelephoneNumber 14025551234 +``` +This example removes the hybrid phone number +1 (402) 555-1234. + +## PARAMETERS + +### -TelephoneNumber +The telephone number to remove. The number should be specified without a prefixed "+". The phone number can't have "tel:" prefixed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### None + +## NOTES + +The cmdlet is only available in GCC High and DoD cloud instances. + +## RELATED LINKS + +[New-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/new-cshybridtelephonenumber) + +[Get-CsHybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) diff --git a/skype/skype-ps/skype/Remove-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md similarity index 71% rename from skype/skype-ps/skype/Remove-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md index c4399e0083..c41907981c 100644 --- a/skype/skype-ps/skype/Remove-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/teams/Remove-CsInboundBlockedNumberPattern.md @@ -1,99 +1,99 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csinboundblockednumberpattern -applicable: Microsoft Teams, Skype for Business Online -title: Remove-CsInboundBlockedNumberPattern -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: bulenteg -schema: 2.0.0 ---- - -# Remove-CsInboundBlockedNumberPattern - -## SYNOPSIS -Removes a blocked number pattern from the tenant list. - -## SYNTAX - -``` -Remove-CsInboundBlockedNumberPattern [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removes a blocked number pattern from the tenant list. - -## EXAMPLES - -### Example 1 -```powershell -PS> Remove-CsInboundBlockedNumberPattern -Identity "BlockAutomatic" -``` - -This example removes a blocked number pattern identified as "BlockAutomatic". - -## PARAMETERS - -### -Identity -A unique identifier specifying the blocked number pattern to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -[New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) - -[Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) - -[Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Remove-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# Remove-CsInboundBlockedNumberPattern + +## SYNOPSIS +Removes a blocked number pattern from the tenant list. + +## SYNTAX + +``` +Remove-CsInboundBlockedNumberPattern [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a blocked number pattern from the tenant list. + +## EXAMPLES + +### Example 1 +```powershell +PS> Remove-CsInboundBlockedNumberPattern -Identity "BlockAutomatic" +``` + +This example removes a blocked number pattern identified as "BlockAutomatic". + +## PARAMETERS + +### -Identity +A unique identifier specifying the blocked number pattern to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) + +[Set-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern) + +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) diff --git a/skype/skype-ps/skype/Remove-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md similarity index 56% rename from skype/skype-ps/skype/Remove-CsInboundExemptNumberPattern.md rename to teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md index 96dcfee74e..2abeb0572b 100644 --- a/skype/skype-ps/skype/Remove-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/teams/Remove-CsInboundExemptNumberPattern.md @@ -1,100 +1,104 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csinboundexemptnumberpattern -applicable: Microsoft Teams, Skype for Business Online -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Remove-CsInboundExemptNumberPattern - -## SYNOPSIS -Removes a number pattern exempt from call blocking. - -## SYNTAX - -``` -Remove-CsInboundExemptNumberPattern [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet removes a specific exempt number pattern from the tenant list for call blocking. - -## EXAMPLES - -### Example 1 -```powershell -PS>Remove-CsInboundExemptNumberPattern -Identity "Exempt1" -``` - -This removes the exempt number patterns with Identity Exempt1. - -## PARAMETERS - -### -Identity -Unique identifier for the exempt number pattern to be listed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -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 -``` - -### -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 -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. - -## RELATED LINKS -[New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) - -[Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) - -[Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) - -[Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) - -[Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: Remove-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Remove-CsInboundExemptNumberPattern + +## SYNOPSIS +Removes a number pattern exempt from call blocking. + +## SYNTAX + +``` +Remove-CsInboundExemptNumberPattern [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet removes a specific exempt number pattern from the tenant list for call blocking. + +## EXAMPLES + +### Example 1 +```powershell +PS>Remove-CsInboundExemptNumberPattern -Identity "Exempt1" +``` + +This removes the exempt number patterns with Identity Exempt1. + +## PARAMETERS + +### -Identity +Unique identifier for the exempt number pattern to be listed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +You can use Test-CsInboundBlockedNumberPattern to test your call block and exempt phone number ranges. + +## RELATED LINKS +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) + +[Set-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern) + +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/skype/skype-ps/skype/Remove-CsOnlineApplicationInstanceAssociation.md b/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md similarity index 73% rename from skype/skype-ps/skype/Remove-CsOnlineApplicationInstanceAssociation.md rename to teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md index a08bf6d8d1..1fb51dfc00 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineApplicationInstanceAssociation.md +++ b/teams/teams-ps/teams/Remove-CsOnlineApplicationInstanceAssociation.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineapplicationinstanceassociation -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineapplicationinstanceassociation +applicable: Microsoft Teams title: Remove-CsOnlineApplicationInstanceAssociation schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsOnlineApplicationInstanceAssociation @@ -44,7 +44,7 @@ The identities for the application instances whose configuration associations ar Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -59,7 +59,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -69,8 +69,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -85,8 +84,8 @@ The Remove-CsOnlineApplicationInstanceAssociation cmdlet accepts a string array ## RELATED LINKS -[Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) +[Get-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociation) -[Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +[Get-CsOnlineApplicationInstanceAssociationStatus](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstanceassociationstatus) -[New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +[New-CsOnlineApplicationInstanceAssociation](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstanceassociation) diff --git a/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..b9ca408b21 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,128 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudioconferencingroutingpolicy +title: Remove-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Remove-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet deletes an instance of the Online Audio Conferencing Routing Policy. + +## SYNTAX + +```powershell +Remove-CsOnlineAudioConferencingRoutingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsOnlineAudioConferencingRoutingPolicy -Identity "Test" +``` + +Deletes an Online Audio Conferencing Routing policy instance with the identity "Test". + +## 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 + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Set-CsOnlineAudioConferencingRoutingPolicy](Set-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/skype/skype-ps/skype/Remove-CsOnlineAudioFile.md b/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md similarity index 59% rename from skype/skype-ps/skype/Remove-CsOnlineAudioFile.md rename to teams/teams-ps/teams/Remove-CsOnlineAudioFile.md index 38aacd762a..61f7bace1f 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineAudioFile.md +++ b/teams/teams-ps/teams/Remove-CsOnlineAudioFile.md @@ -1,76 +1,76 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineaudiofile -applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Remove-CsOnlineAudioFile - -## SYNOPSIS -Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours). - - -## SYNTAX - -```powershell -Remove-CsOnlineAudioFile -Identity [] - -``` - -## DESCRIPTION -This cmdlet marks an audio file of application type TenantGlobal for deletion and later removal. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsOnlineAudioFile -Identity dcfcc31daa9246f29d94d0a715ef877e -``` -This cmdlet marks the audio file with Id dcfcc31daa9246f29d94d0a715ef877e for deletion and later removal. - -## PARAMETERS - -### -Identity -The Id of the specific audio file that you would like to mark for deletion. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES -Please note that using this cmdlet on other application types like OrgAutoAttendant and HuntGroup does not mark the audio file for deletion. These kinds of audio files will automatically be deleted, when - -the corresponding Auto Attendant or Call Queue is deleted. - -The cmdlet is available in Teams PS module 2.4.0-preview or later. - -## RELATED LINKS - -[Export-CsOnlineAudioFile](Export-CsOnlineAudioFile.md) - -[Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) - -[Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) - -[New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile +applicable: Microsoft Teams +title: Remove-CsOnlineAudioFile +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Remove-CsOnlineAudioFile + +## SYNOPSIS +Marks an audio file of application type TenantGlobal for deletion and later removal (within 24 hours). + +## SYNTAX + +```powershell +Remove-CsOnlineAudioFile -Identity [] + +``` + +## DESCRIPTION +This cmdlet marks an audio file of application type TenantGlobal for deletion and later removal. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsOnlineAudioFile -Identity dcfcc31daa9246f29d94d0a715ef877e +``` +This cmdlet marks the audio file with Id dcfcc31daa9246f29d94d0a715ef877e for deletion and later removal. + +## PARAMETERS + +### -Identity +The Id of the specific audio file that you would like to mark for deletion. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +Please note that using this cmdlet on other application types like OrgAutoAttendant and HuntGroup does not mark the audio file for deletion. These kinds of audio files will automatically be deleted, when + +the corresponding Auto Attendant or Call Queue is deleted. + +The cmdlet is available in Teams PS module 2.4.0-preview or later. + +## RELATED LINKS + +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) + +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/skype/skype-ps/skype/Remove-CsOnlineDialInConferencingTenantSettings.md b/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsOnlineDialInConferencingTenantSettings.md rename to teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md index e186ca7efa..09faa588af 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineDialInConferencingTenantSettings.md +++ b/teams/teams-ps/teams/Remove-CsOnlineDialInConferencingTenantSettings.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinedialinconferencingtenantsettings -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings +applicable: Microsoft Teams title: Remove-CsOnlineDialInConferencingTenantSettings schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsOnlineDialInConferencingTenantSettings @@ -35,7 +35,6 @@ Remove-CsOnlineDialInConferencingTenantSettings This example reverts the tenant level dial-in conferencing settings to their original defaults. - ## PARAMETERS ### -Identity @@ -44,8 +43,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -61,7 +60,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -78,8 +77,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -94,8 +93,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -112,7 +111,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -122,19 +121,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None - ## OUTPUTS -### -None - ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md similarity index 78% rename from skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md index 8eb77bbc4f..e78d109481 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md @@ -1,19 +1,21 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineliscivicaddress -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress +applicable: Microsoft Teams title: Remove-CsOnlineLisCivicAddress schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # Remove-CsOnlineLisCivicAddress ## SYNOPSIS -Use the Remove-CsOnlineLisCivicAddress cmdlet to delete an existing civic address from the Location Information Server (LIS). You can't remove a civic address if any of its associated locations are assigned to users. +Use the Remove-CsOnlineLisCivicAddress cmdlet to delete an existing civic address from the Location Information Server (LIS). + +You can't remove a civic address if any of its associated locations are assigned to users or phone numbers. ## SYNTAX @@ -50,7 +52,7 @@ You can find civic address identifiers by using the Get-CsOnlineLisCivicAddress Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: True Position: Named @@ -68,7 +70,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -85,7 +87,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -101,7 +103,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -125,8 +127,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisCivicAddress](set-csonlineliscivicaddress.md) +[Set-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](new-csonlineliscivicaddress.md) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) -[Get-CsOnlineLisCivicAddress](get-csonlineliscivicaddress.md) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisLocation.md b/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md similarity index 72% rename from skype/skype-ps/skype/Remove-CsOnlineLisLocation.md rename to teams/teams-ps/teams/Remove-CsOnlineLisLocation.md index 359cbb0255..4006964361 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md @@ -1,19 +1,22 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinelislocation +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation applicable: Microsoft Teams title: Remove-CsOnlineLisLocation schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # Remove-CsOnlineLisLocation ## SYNOPSIS -Use the \`Remove-CsOnlineLisLocation\` cmdlet to remove an existing emergency location from the Location Information Service (LIS.) You can only remove locations that have no assigned users. +Use the Remove-CsOnlineLisLocation cmdlet to remove an existing emergency location from the Location Information Service (LIS). + +You can only remove locations that have no assigned users or phone numbers. You can't remove the default location, you will have to delete the associated +civic address which will delete the default location. ## SYNTAX ``` @@ -36,7 +39,7 @@ This example removes the location specified by its identity. ### -LocationId Specifies the unique identifier of the location to be deleted. -Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. +Location identities can be discovered by using the Get-CsOnlineLisLocation cmdlet. ```yaml Type: Guid @@ -107,7 +110,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### This cmdlet supports pipelined input from the \`Get-CsOnlineLisLocation\` cmdlet. +### This cmdlet supports pipelined input from the Get-CsOnlineLisLocation cmdlet. ## OUTPUTS @@ -117,8 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +[Set-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation) -[Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) -[New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisPort.md b/teams/teams-ps/teams/Remove-CsOnlineLisPort.md similarity index 93% rename from skype/skype-ps/skype/Remove-CsOnlineLisPort.md rename to teams/teams-ps/teams/Remove-CsOnlineLisPort.md index c7cddc93ac..6e1665a058 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisPort.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisPort.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinelisport +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport applicable: Microsoft Teams title: Remove-CsOnlineLisPort schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -17,7 +17,7 @@ Removes an association between a Location port and a location. This association ## SYNTAX ``` -Remove-CsOnlineLisPort [-ChassisID] -PortID [-Force] [-IsDebug ] [-NCSApiUrl ] [-TargetStore ] +Remove-CsOnlineLisPort [-ChassisID] -PortID [-Force] [-IsDebug ] [-NCSApiUrl ] [-TargetStore ] [-WhatIf] [-Confirm] [] ``` @@ -35,7 +35,6 @@ Remove-CsOnlineLisPort -PortID 12174 -ChassisID 0B-23-CD-16-AA-CC Example 1 removes the location information for port 12174 with ChassisID 0B-23-CD-16-AA-CC. - ## PARAMETERS ### -ChassisID @@ -186,6 +185,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +[Set-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport) -[Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisSubnet.md b/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsOnlineLisSubnet.md rename to teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md index d732b51b9e..eec633e37e 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisSubnet.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisSubnet.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinelissubnet -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelissubnet +applicable: Microsoft Teams title: Remove-CsOnlineLisSubnet schema: 2.0.0 author: serdarsoysal @@ -33,7 +33,6 @@ Remove-CsOnlineLisSubnet -Subnet 10.10.10.10 Example 1 removes the Location Information Service subnet "10.10.10.10". - ### -------------------------- Example 2 -------------------------- ``` Remove-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e @@ -41,7 +40,6 @@ Remove-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e Example 1 removes the Location Information Service subnet "2001:4898:e8:6c:90d2:28d4:76a4:ec5e". - ## PARAMETERS ### -Confirm @@ -51,7 +49,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -69,7 +67,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -85,7 +83,7 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -101,7 +99,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -117,7 +115,7 @@ The IP address of the subnet. This value can be either IPv4 or IPv6 format. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 1 @@ -133,7 +131,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -149,7 +147,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -166,7 +164,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -187,6 +185,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisSwitch.md b/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsOnlineLisSwitch.md rename to teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md index 425e201fb8..be82fd7ba5 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisSwitch.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisSwitch.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinelisswitch +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch applicable: Microsoft Teams title: Remove-CsOnlineLisSwitch schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -17,7 +17,7 @@ Removes a Location Information Server (LIS) network switch. ## SYNTAX ``` -Remove-CsOnlineLisSwitch [-ChassisID] [-Force] [-IsDebug ] [-NCSApiUrl ] +Remove-CsOnlineLisSwitch [-ChassisID] [-Force] [-IsDebug ] [-NCSApiUrl ] [-TargetStore ] [-WhatIf] [-Confirm] [] ``` @@ -167,6 +167,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +[Set-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch) -[Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) diff --git a/skype/skype-ps/skype/Remove-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md index 998dc33973..ff2c7da4d7 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisWirelessAccessPoint.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint applicable: Microsoft Teams title: Remove-CsOnlineLisWirelessAccessPoint schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -164,7 +164,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -177,6 +176,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +[Set-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint) -[Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) diff --git a/skype/skype-ps/skype/Remove-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md similarity index 59% rename from skype/skype-ps/skype/Remove-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md index 91ba51a16b..6af2287599 100644 --- a/skype/skype-ps/skype/Remove-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinepstngateway -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway +applicable: Microsoft Teams title: Remove-CsOnlinePSTNGateway schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -17,7 +17,7 @@ Removes the configuration of the previously defined Session Border Controller(s) ## SYNTAX ``` -Remove-CsOnlinePSTNGateway -Identity +Remove-CsOnlinePSTNGateway [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,39 +32,28 @@ PS C:\> Remove-CsOnlinePSTNGateway -Identity sbc.contoso.com This example removes SBC with Identity (and FQDN) sbc.contoso.com. -### Example 2 -```powershell -PS C:\> Remove-CsOnlinePSTNGateway | ?{$_.Identity -like "*.contoso.com"} -``` - -This example removes the SBCs with identities (and FQDNs) matching the pattern *.contoso.com. For example: sbc1.contoso.com, sbc2.contoso.com etc. - ## PARAMETERS ### -Identity The parameter is mandatory for the cmdlet. The Identity is the same as the SBC FQDN. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: True Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: 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/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity - - ## OUTPUTS ### System.Object @@ -73,8 +62,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +[Set-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway) -[New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) diff --git a/skype/skype-ps/skype/Remove-CsOnlineSchedule.md b/teams/teams-ps/teams/Remove-CsOnlineSchedule.md similarity index 57% rename from skype/skype-ps/skype/Remove-CsOnlineSchedule.md rename to teams/teams-ps/teams/Remove-CsOnlineSchedule.md index 7067de8a56..6dc49f8900 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineSchedule.md +++ b/teams/teams-ps/teams/Remove-CsOnlineSchedule.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlineschedule -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule +applicable: Microsoft Teams title: Remove-CsOnlineSchedule schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsOnlineSchedule @@ -17,7 +17,7 @@ Use the Remove-CsOnlineSchedule cmdlet to remove a schedule. ## SYNTAX ``` -Remove-CsOnlineSchedule -Id [-Tenant ] [-CommonParameters] +Remove-CsOnlineSchedule -Id [-Tenant ] [] ``` ## DESCRIPTION @@ -30,20 +30,18 @@ The Remove-CsOnlineSchedule cmdlet deletes a schedule that is specified by using Remove-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" ``` -This example deletes the schedule that has a Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. - +This example deletes the schedule that has an Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. ## PARAMETERS ### -Id The Id for the schedule to be removed. - ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -58,7 +56,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -68,23 +66,21 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String The Remove-CsOnlineSchedule cmdlet accepts a string as the Id parameter. - ## OUTPUTS ### System.Void - ## NOTES ## RELATED LINKS -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) -[Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) +[Set-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule) diff --git a/skype/skype-ps/skype/Remove-CsOnlineTelephoneNumber.md b/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsOnlineTelephoneNumber.md rename to teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md index aa8f14a985..4c26d98627 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/teams/Remove-CsOnlineTelephoneNumber.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinetelephonenumber -applicable: Skype for Business Online, Microsoft Teams +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber +applicable: Microsoft Teams title: Remove-CsOnlineTelephoneNumber schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -47,22 +47,20 @@ Remove-CsOnlineTelephoneNumber -TelephoneNumber $tns NumberIdsDeleted NumberIdsDeleteFailed NumberIdsNotOwnedByTenant NumberIdsManagedByServiceDesk ---------------- --------------------- ------------------------- ----------------------------- {14255551234, {} {} {} - 14255551233} + 14255551233} ``` This example removes the specified list of telephone numbers from the tenant. - ## PARAMETERS ### -TelephoneNumber -Specifies the telephone number(s) to remove. The format can be withor without the prefixed +, but needs to include country code etc. +Specifies the telephone number(s) to remove. The format can be with or without the prefixed +, but needs to include country code etc. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: True Position: Named @@ -78,7 +76,6 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online, Microsoft Teams Required: False Position: Named @@ -95,8 +92,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: False Position: Named @@ -113,7 +109,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online, Microsoft Teams Required: False Position: Named @@ -123,20 +118,20 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None ## OUTPUTS -### +### Output types None ## NOTES If one or more of the telephone numbers are assigned to a user or a service, the cmdlet will display an error message and none of the telephone numbers specified will be removed from your tenant. ## RELATED LINKS -[Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +[Get-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber) diff --git a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md similarity index 62% rename from skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md index 1e27137730..c2487ee802 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroute -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute +applicable: Microsoft Teams title: Remove-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -17,7 +17,7 @@ Removes an online voice route. Online voice routes contain instructions that tel ## SYNTAX ``` -Remove-CsOnlineVoiceRoute [-Tenant ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] +Remove-CsOnlineVoiceRoute [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,6 +49,7 @@ PS C:\ Get-CsOnlineVoiceRoute -Filter *Redmond* | Remove-CsOnlineVoiceRoute This command removes all online voice routes with an identity that includes the string "Redmond". First the `Get-CsOnlineVoiceRoute` cmdlet is called with the Filter parameter. The value of the Filter parameter is the string Redmond surrounded by wildcard characters (\*), which specifies that the string can be anywhere within the Identity. After all of the online voice routes with identities that include the string Redmond are retrieved, these online voice routes are piped to the `Remove-CsOnlineVoiceRoute` cmdlet, which removes each one. ## PARAMETERS + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -64,56 +65,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The unique identity of the online voice route. (If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: -Required: False +Required: True Position: 1 Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False +Accept pipeline input: ByPropertyName Accept wildcard characters: False ``` @@ -134,14 +97,10 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity - - ## OUTPUTS ### System.Object @@ -149,8 +108,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) diff --git a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md similarity index 65% rename from skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md index 186b73e5b0..a92e803b2c 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroutingpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy +applicable: Microsoft Teams title: Remove-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,8 +19,7 @@ Deletes an existing online voice routing policy. Online voice routing policies m ### Identity ``` -Remove-CsOnlineVoiceRoutingPolicy [[-Identity] ] [-Tenant ] [-Force] [-WhatIf] -[] +Remove-CsOnlineVoiceRoutingPolicy [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,51 +52,29 @@ In Example 3, all the online voice routing polices that include the online PSTN ## PARAMETERS -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier assigned to the policy when it was created. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: -Required: False +Required: True Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: ByPropertyName Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose online voice routing policy is being removed. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -106,14 +83,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -123,14 +99,10 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### Microsoft.Rtc.Management.Xds.XdsIdentity - - ## OUTPUTS ### System.Object @@ -138,10 +110,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroutingpolicy?view=skype-ps) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) diff --git a/skype/skype-ps/skype/Remove-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md similarity index 67% rename from skype/skype-ps/skype/Remove-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md index cc6d6f3c7c..37611ecdb3 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy +applicable: Microsoft Teams title: Remove-CsOnlineVoicemailPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -40,8 +40,8 @@ A unique identifier specifying the scope, and in some cases the name, of the pol ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -57,7 +57,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -73,7 +73,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -83,7 +83,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -93,10 +93,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable You are not able to delete the pre-configured policy instances Default, TranscriptionProfanityMaskingEnabled and TranscriptionDisabled ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoicemailpolicy?view=skype-ps) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md index 41086319c0..2bd32016e0 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-csphonenumberassignment +online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Remove-CsPhoneNumberAssignment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Remove-CsPhoneNumberAssignment @@ -15,9 +16,6 @@ schema: 2.0.0 ## SYNOPSIS This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). -**Note**: This cmdlet is currently not supported for customers and tenants that are or have been enabled for Regionally Hosted Meetings for Skype for Business Online. These -customers should continue to use the Set-CsUser, Set-CsOnlineVoiceUser, Set-CsOnlineApplicationInstance, or Set-CsOnlineVoiceApplicationInstance cmdlets. - ## SYNTAX ### RemoveSome (Default) @@ -35,12 +33,12 @@ This cmdlet removes/unassigns a phone number from a user or resource account. Th Unassigning a phone number from a user or resource account will automatically set EnterpriseVoiceEnabled to False. -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string -parameter and a Message string parameter with additional details of the failure. +If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a +Code string parameter and a Message string parameter with additional details of the failure. **Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also -now support the -ErrorAction parameter to control the execution after an error has occured. +now support the -ErrorAction parameter to control the execution after an error has occurred. ## EXAMPLES @@ -56,7 +54,6 @@ Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll ``` This example removes/unassigns the phone number from user2@contoso.com. - ## PARAMETERS ### -Identity @@ -77,7 +74,6 @@ Accept wildcard characters: False ### -PhoneNumber The phone number to unassign from the user or resource account. Supports E.164 format and non-E.164 format. Needs to be without the prefixed "tel:". - ```yaml Type: System.String Parameter Sets: (RemoveSome) @@ -134,6 +130,6 @@ The cmdlet is available in Teams PowerShell module 3.0.0 or later. The cmdlet is only available in commercial and GCC cloud instances. ## RELATED LINKS -[Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) -[Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md b/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md new file mode 100644 index 0000000000..38cda0282c --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsPhoneNumberTag.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/remove-csphonenumbertag +applicable: Microsoft Teams +title: Remove-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Remove-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows admin to remove a tag from phone number. + +## SYNTAX + +``` +Remove-CsPhoneNumberTag -Tag [-PhoneNumber ] [] +``` + +## DESCRIPTION +This cmdlet allows telephone number administrators to remove existing tags from any telephone numbers. This method does not delete the tag from the system if the tag is assigned to other telephone numbers. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR" +``` + +This example shows how to remove the tag "HR" from telephone number +123456789. + +## PARAMETERS + +### -PhoneNumber +Indicates the phone number for the the tag to be removed from + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Indicates the tag to be removed. + +```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.Boolean + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..b50b153b93 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: Remove-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Remove-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +Remove-CsSharedCallQueueHistoryTemplate -Id [] +``` + +## DESCRIPTION +Use the Remove-CsSharedCallQueueHistoryTemplate cmdlet to delete a Shared Call Queue History template. If the template is currently assigned to a call queue, an error will be returned. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Remove-CsSharedCallQueueHistoryTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +``` + +This example deletes the Shared Call Queue History template with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no Shared Call Queue History template exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error. + +## PARAMETERS + +### -Id +The Id parameter is the unique identifier assigned to the Shared Call Queue History template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsSharedCallQueueHistoryTemplate](./New-CsSharedCallQueueHistoryTemplate.md) + +[Set-CsSharedCallQueueHistoryTemplate](./Set-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsSharedCallQueueHistoryTemplate](./Get-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Remove-CsTeamTemplate.md b/teams/teams-ps/teams/Remove-CsTeamTemplate.md index 478ea9ff15..ee73ec6d3d 100644 --- a/teams/teams-ps/teams/Remove-CsTeamTemplate.md +++ b/teams/teams-ps/teams/Remove-CsTeamTemplate.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate title: Remove-CsTeamTemplate author: serdarsoysal ms.author: serdars -ms.reviewer: +ms.reviewer: manager: farahf schema: 2.0.0 --- @@ -39,7 +39,7 @@ Remove-CsTeamTemplate -InputObject [-Break] ### EXAMPLE 1 ```powershell -PS C:> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' +PS C:\> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US' ``` Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'. @@ -47,10 +47,10 @@ Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b- ### EXAMPLE 2 ```powershell -PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} +PS C:\> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId} ``` -Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains ‘test’. +Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'. ## PARAMETERS @@ -262,12 +262,12 @@ INPUTOBJECT \: Identity Parameter ## RELATED LINKS -[Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +[Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -[Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate) +[Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) -[New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate) +[New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) -[Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate) +[Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) -[Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate) +[Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) diff --git a/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..01ddbc1bcc --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsAIPolicy.md @@ -0,0 +1,73 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Remove-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Remove-CsTeamsAIPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams AI policy. + +## SYNTAX + +``` +Remove-CsTeamsAIPolicy -Identity [] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet deletes a Teams AI policy with the specified identity string. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsAIPolicy -Identity "Test" +``` + +Deletes a Teams AI policy with the identify of "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) + +[Set-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaipolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md similarity index 70% rename from skype/skype-ps/skype/Remove-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md index 5be1b04191..409570c300 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md @@ -1,145 +1,146 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsapppermissionpolicy -applicable: Skype for Business Online -title: Remove-CsTeamsAppPermissionPolicy -schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau ---- - -# Remove-CsTeamsAppPermissionPolicy - -## SYNOPSIS -**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experienc - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: . - -This cmdlet allows you to remove app permission policies that have been created within your organization. If you run Remove-CsTeamsAppPermissionPolicy on the Global policy, it will be reset to the defaults provided for new organizations. - -## SYNTAX - -``` -Remove-CsTeamsAppSetupPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experienc - -As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: . - -This cmdlet allows you to remove app permission policies that have been created within your organization. If you run Remove-CsTeamsAppPermissionPolicy on the Global policy, it will be reset to the defaults provided for new organizations. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsAppPermissionPolicy -Identity SalesPolicy -``` - -Deletes a custom policy that has already been created in the organization. - -## PARAMETERS - -### -Identity -Unique identifier for the policy to be removed. -To "remove" the global policy, use the following syntax: `-Identity global`. -(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. -You cannot use wildcards when specifying a policy Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business 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.Rtc.Management.Xds.XdsIdentity - - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +ms.author: prkosh +author: ashishguptaiitb +--- + +# Remove-CsTeamsAppPermissionPolicy + +## SYNOPSIS + +**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . + +This cmdlet allows you to remove app permission policies that have been created within your organization. If you run `Remove-CsTeamsAppPermissionPolicy` on the Global policy, it will be reset to the defaults provided for new organizations. + +**This is only applicable for tenants who have not been migrated to ACM or UAM.** + +## SYNTAX + +``` +Remove-CsTeamsAppSetupPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +**NOTE**: You can use this cmdlet to remove a specific custom policy from a user. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Permission Policies: . + +This cmdlet allows you to remove app permission policies that have been created within your organization. If you run Remove-CsTeamsAppPermissionPolicy on the Global policy, it will be reset to the defaults provided for new organizations. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsAppPermissionPolicy -Identity SalesPolicy +``` + +Deletes a custom policy that has already been created in the organization. + +## PARAMETERS + +### -Identity +Unique identifier for the policy to be removed. +To "remove" the global policy, use the following syntax: `-Identity global`. +(Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: `-Identity "SalesDepartmentPolicy"`. +You cannot use wildcards when specifying a policy Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md index 219c5aee8d..fa290e6383 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsappsetuppolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsappsetuppolicy +applicable: Microsoft Teams title: Remove-CsTeamsAppSetupPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTeamsAppSetupPolicy @@ -17,7 +17,7 @@ ms.reviewer: As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. @@ -33,7 +33,7 @@ Remove-CsTeamsAppSetupPolicy [-Tenant ] [-Identity] [-Force] As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . If you run Remove-CsTeamsAppSetupPolicy on the Global policy, it will be reset to the defaults provided for new organizations. @@ -57,8 +57,8 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: 2 @@ -73,8 +73,8 @@ Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -90,7 +90,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -106,7 +106,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -121,8 +121,8 @@ Internal Microsoft use only. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -132,14 +132,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Remove-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md similarity index 76% rename from skype/skype-ps/skype/Remove-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md index 89b353e193..5866a31e39 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/remove-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy +title: Remove-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -24,10 +25,10 @@ Deletes a previously created TeamsAudioConferencingPolicy. Any users with no exp ### EXAMPLE 1 ``` -PS C:\> Remove-CsTeamsAudioCOnferencingPolicy -Identity “Emea Users” +PS C:\> Remove-CsTeamsAudioCOnferencingPolicy -Identity "Emea Users" ``` -In the example shown above, the command will delete the “Emea Users” audio conferencing policy from the organization's list of policies. +In the example shown above, the command will delete the "Emea Users" audio conferencing policy from the organization's list of policies. ## PARAMETERS @@ -48,7 +49,7 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier for the TeamsAudioConferencingPolicy to be removed. To remove global policy, use this syntax: -Identity global. (Note that the global policy cannot be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity . +Unique identifier for the TeamsAudioConferencingPolicy to be removed. To remove global policy, use this syntax: -Identity global. (Note that the global policy cannot be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: `-Identity ""`. ```yaml Type: String @@ -106,8 +107,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) \ No newline at end of file +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md similarity index 73% rename from skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md index 3d386abfe6..e735cc0dc3 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md @@ -1,150 +1,131 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamscallholdpolicy -applicable: Microsoft Teams -title: Remove-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: -manager: abnair -ms.author: jomarque -author: joelhmarquez ---- - -# Remove-CsTeamsCallHoldPolicy - -## SYNOPSIS - -Deletes an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. - - -## SYNTAX - -``` -Remove-CsTeamsCallHoldPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Teams call hold policies are used to customize the call hold experience for teams clients. -When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. - -Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> Remove-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerTeamsCallHoldPolicy' -``` - -The command shown in Example 1 deletes the Teams call hold policy ContosoPartnerTeamsCallHoldPolicy. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' | Remove-CsTeamsCallHoldPolicy -``` - -In Example 2, all the Teams call hold policies configured at the per-user scope are removed. -The Filter value "Tag:*" limits the returned data to Teams call hold policies configured at the per-user scope. Those per-user policies are then removed. - -## 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 -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams call hold policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) - -[Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) - -[Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) - -[Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Remove-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Deletes an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +``` +Remove-CsTeamsCallHoldPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsCallHoldPolicy -Identity 'ContosoPartnerTeamsCallHoldPolicy' +``` + +The command shown in Example 1 deletes the Teams call hold policy ContosoPartnerTeamsCallHoldPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsCallHoldPolicy -Filter 'Tag:*' | Remove-CsTeamsCallHoldPolicy +``` + +In Example 2, all the Teams call hold policies configured at the per-user scope are removed. +The Filter value "Tag:*" limits the returned data to Teams call hold policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams call hold policy to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[Set-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsTeamsCallParkPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md index ef22398bb0..8504928e7c 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsCallParkPolicy.md @@ -1,16 +1,15 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamscallparkpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallparkpolicy +applicable: Microsoft Teams title: Remove-CsTeamsCallParkPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- - # Remove-CsTeamsCallParkPolicy ## SYNOPSIS @@ -49,8 +48,8 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: 2 @@ -65,8 +64,8 @@ Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -82,7 +81,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -98,7 +97,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -113,8 +112,8 @@ Internal Microsoft use only. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -124,14 +123,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Remove-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md similarity index 74% rename from skype/skype-ps/skype/Remove-CsTeamsCallingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md index c04ac65600..f22acb63d5 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsCallingPolicy.md @@ -1,114 +1,109 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamscallingpolicy -applicable: Microsoft Teams -title: Remove-CsTeamsCallingPolicy -author: jenstrier -ms.author: jenstr -manager: roykuntz -ms.reviewer: -schema: 2.0.0 ---- - -# Remove-CsTeamsCallingPolicy - -## SYNOPSIS - -## SYNTAX - -``` -Remove-CsTeamsCallingPolicy [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - This cmdlet removes an existing Teams Calling Policy instance or resets the Global policy instance to the default values. - - -## EXAMPLES - -### Example 1 -```powershell -PS C:> Remove-CsTeamsCallingPolicy -Identity Sales -``` - -This example removes the Teams Calling Policy with identity Sales - - -### Example 2 -```powershell -PS C:> Remove-CsTeamsCallingPolicy -Identity Global -``` - -This example resets the Global Policy instance to the default values. - - -## PARAMETERS - -### -Identity - The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -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](https://go.microsoft.com/fwlink/?LinkID=113216). - - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) - -[Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) - -[Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) - -[New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: +schema: 2.0.0 +--- + +# Remove-CsTeamsCallingPolicy + +## SYNOPSIS + +## SYNTAX + +``` +Remove-CsTeamsCallingPolicy [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + This cmdlet removes an existing Teams Calling Policy instance or resets the Global policy instance to the default values. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsCallingPolicy -Identity Sales +``` + +This example removes the Teams Calling Policy with identity Sales + +### Example 2 +```powershell +PS C:\> Remove-CsTeamsCallingPolicy -Identity Global +``` + +This example resets the Global Policy instance to the default values. + +## PARAMETERS + +### -Identity + The Identity parameter is the unique identifier of the Teams Calling Policy instance to remove or reset. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy) + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md index 1f6ecb0412..1adb7d3231 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsChannelsPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamschannelspolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy +applicable: Microsoft Teams title: Remove-CsTeamsChannelsPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTeamsChannelsPolicy @@ -49,8 +49,8 @@ To "remove" the global policy, use the following syntax: `-Identity Global`. You ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: 2 @@ -66,7 +66,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -81,8 +81,8 @@ Suppresses all non-fatal errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -97,8 +97,8 @@ Internal Microsoft use only. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -114,7 +114,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -124,8 +124,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md similarity index 78% rename from skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md index 115ac36f6b..05cb425285 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md @@ -1,178 +1,180 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication -applicable: Skype for Business Online -title: Remove-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Remove-CsTeamsComplianceRecordingApplication - -## SYNOPSIS -Deletes an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -``` -Remove-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Policy-based recording applications are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. - -Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. - -Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -Once the association is done, the Identity of these application instances becomes \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. -Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -``` - -The command shown in Example 1 deletes an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingApplication | Remove-CsTeamsComplianceRecordingApplication -``` - -The command shown in Example 2 deletes all existing associations between application instances of policy-based recording applications and their corresponding Teams compliance recording policy. - -## PARAMETERS - -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. - -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams compliance recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: Remove-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Remove-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Deletes an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +``` +Remove-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' +``` + +The command shown in Example 1 deletes an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication | Remove-CsTeamsComplianceRecordingApplication +``` + +The command shown in Example 2 deletes all existing associations between application instances of policy-based recording applications and their corresponding Teams compliance recording policy. + +## PARAMETERS + +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. + +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams compliance recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md similarity index 75% rename from skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md index c32c81e682..c121ab2692 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md @@ -1,177 +1,179 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy -applicable: Skype for Business Online -title: Remove-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Remove-CsTeamsComplianceRecordingPolicy - -## SYNOPSIS -Deletes an existing Teams recording policy that is used to govern automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -``` -Remove-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams recording policies are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. - -Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. -Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. -The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. -Existing calls and meetings are unaffected. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -``` - -The command shown in Example 1 deletes the Teams recording policy ContosoPartnerComplianceRecordingPolicy. - -### Example 2 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingPolicy -Filter 'Tag:*' | Remove-CsTeamsComplianceRecordingPolicy -``` - -In Example 2, all the Teams recording policies configured at the per-user scope are removed. -The Filter value "Tag:*" limits the returned data to Teams recording policies configured at the per-user scope. Those per-user policies are then removed. - -## PARAMETERS - -### -Identity -Unique identifier to be assigned to the new Teams recording policy. - -Use the "Global" Identity if you wish to assign this policy to the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Remove-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Deletes an existing Teams recording policy that is used to govern automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +``` +Remove-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' +``` + +The command shown in Example 1 deletes the Teams recording policy ContosoPartnerComplianceRecordingPolicy. + +### Example 2 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy -Filter 'Tag:*' | Remove-CsTeamsComplianceRecordingPolicy +``` + +In Example 2, all the Teams recording policies configured at the per-user scope are removed. +The Filter value "Tag:*" limits the returned data to Teams recording policies configured at the per-user scope. Those per-user policies are then removed. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md index 2e3f9a4039..bac8a3df1d 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsCortanaPolicy.md @@ -1,131 +1,132 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscortanapolicy -applicable: Skype for Business Online -title: Remove-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta -author: akshbhat -ms.author: akshbhat -ms.reviewer: ---- - -# Remove-CsTeamsCortanaPolicy - -## SYNOPSIS -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. - -## SYNTAX - -``` -Remove-CsTeamsCortanaPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -Deletes a previously created TeamsCortanaPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -``` - -In the example shown above, the command will delete the MyCortanaPolicy from the organization's list of policies. - -## 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 -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Identity for the policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity MyCortanaPolicy. -If you do not specify an Identity the Set-CsTeamsCortanaPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -You can return your tenant ID by running this command: -Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Remove-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +``` +Remove-CsTeamsCortanaPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes a previously created TeamsCortanaPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsCortanaPolicy -Identity MyCortanaPolicy +``` + +In the example shown above, the command will delete the MyCortanaPolicy from the organization's list of policies. + +## 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 +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity for the policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity MyCortanaPolicy. +If you do not specify an Identity the Set-CsTeamsCortanaPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +You can return your tenant ID by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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 + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText new file mode 100644 index 0000000000..9e9dcd1434 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText @@ -0,0 +1,71 @@ +--- +Module Name: MicrosoftTeams +title: Remove-CsTeamsCustomBannerText +author: saleens7 +ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText +schema: 2.0.0 +--- + +# Remove-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Remove-CsTeamsCustomBannerText [[-Identity] ] [] +``` + +## DESCRIPTION + +Removes a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText +``` + +Removes a TeamsCustomBannerText instance with the name "CustomText". + +## PARAMETERS + +### -Identity +Policy instance name (optional). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +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 + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..8619d8cca2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md @@ -0,0 +1,71 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText +title: Remove-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# Remove-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Remove-CsTeamsCustomBannerText [[-Identity] ] [] +``` + +## DESCRIPTION + +Removes a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Remove-CsTeamsCustomBannerText -Identity CustomText +``` + +This example removes a TeamsCustomBannerText instance with the name "CustomText". + +## PARAMETERS + +### -Identity +Policy instance name (optional). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +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 + +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/skype/skype-ps/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md similarity index 69% rename from skype/skype-ps/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md index 9782edd882..09e839d382 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsemergencycallroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy applicable: Microsoft Teams title: Remove-CsTeamsEmergencyCallRoutingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc schema: 2.0.0 @@ -28,10 +28,10 @@ This cmdlet removes an existing Teams Emergency Call Routing policy instance. ### Example 1 ```powershell -Remove-CsTeamsEmergencyCallRoutingPolicy -Identity TestECRP +Remove-CsTeamsEmergencyCallRoutingPolicy -Identity Test ``` -This example removes Teams Emergency Call Routing policy with identity TestECRP. +This example removes Teams Emergency Call Routing policy with identity Test. ### Example 2 ```powershell @@ -89,7 +89,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -99,10 +99,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) -[Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +[Set-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy) -[Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md similarity index 71% rename from skype/skype-ps/skype/Remove-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md index 662f46d1e7..0f35301904 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsEmergencyCallingPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsemergencycallingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy applicable: Microsoft Teams title: Remove-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc schema: 2.0.0 @@ -88,7 +88,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -97,14 +97,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) -[Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +[Set-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md index b580ebd556..2e310c4d61 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy title: Remove-CsTeamsEnhancedEncryptionPolicy -author: xinawang -ms.author: xinawang +author: serdarsoysal +ms.author: serdars manager: mdress schema: 2.0.0 --- @@ -35,7 +35,6 @@ PS C:\> Remove-CsTeamsEnhancedEncryptionPolicy -Identity 'ContosoPartnerTeamsEnh The command shown in Example 1 deletes the Teams enhanced encryption policy ContosoPartnerTeamsEnhancedEncryptionPolicy. - ### EXAMPLE 2 ```PowerShell PS C:\> Get-CsTeamsEnhancedEncryptionPolicy -Filter 'Tag:*' | Remove-CsTeamsEnhancedEncryptionPolicy @@ -48,7 +47,6 @@ In Example 2, all the Teams enhanced encryption policies configured at the per-u ### -Identity Unique identifier assigned to the Teams enhanced encryption policy. - ```yaml Type: XdsIdentity Parameter Sets: (All) @@ -110,23 +108,21 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Object ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) - -[New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) - -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) -[Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..adc94c0242 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md @@ -0,0 +1,94 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamseventspolicy +title: Remove-CsTeamsEventsPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsEventsPolicy + +## SYNOPSIS +The CsTeamsEventsPolicy cmdlets removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Remove-CsTeamsEventsPolicy [-Identity] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes a previously created TeamsEventsPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsEventsPolicy -Identity DisablePublicWebinars +``` + +In this example, the command will delete the DisablePublicWebinars policy from the organization's list of policies. + +## 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 +Unique identifier for the teams events policy to be removed. To remove the global policy, use this syntax: -Identity Global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy DisablePublicWebinars, use this syntax: -Identity DisablePublicWebinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md similarity index 77% rename from skype/skype-ps/skype/Remove-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md index 1acbd7615e..c001e0e880 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsFeedbackPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsfeedbackpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfeedbackpolicy +applicable: Microsoft Teams title: Remove-CsTeamsFeedbackPolicy schema: 2.0.0 manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau ms.reviewer: --- @@ -19,7 +19,12 @@ Use this cmdlet to remove a Teams Feedback policy from the Tenant. ## SYNTAX ``` -Remove-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-Force] +Remove-CsTeamsFeedbackPolicy [[-Identity] ] + [-Confirm] + [-Force] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -70,7 +75,7 @@ Accept wildcard characters: False The identity of the policy to be removed. ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: @@ -112,6 +117,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsIdentity @@ -119,6 +127,7 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..8b2f609c8e --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsFilesPolicy.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy +title: Remove-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsFilesPolicy + +## SYNOPSIS +Deletes an existing teams files policy or resets the Global policy instance to the default values. + +## SYNTAX + +``` +Remove-CsTeamsFilesPolicy [-Identity] [] +``` + +## DESCRIPTION +Deletes an existing teams files or resets the Global policy instance to the default values. + +## EXAMPLES + +### Example 1 +``` +Remove-CsTeamsFilesPolicy -Identity "Customteamsfilespolicy" +``` + +The command shown in Example 1 deletes a per-user teams files policy Customteamsfilespolicy. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +You are not able to delete the pre-configured policy instances Default, TranscriptionProfanityMaskingEnabled and TranscriptionDisabled + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) + diff --git a/skype/skype-ps/skype/Remove-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md similarity index 76% rename from skype/skype-ps/skype/Remove-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md index 3160add5b1..f31fdeafd5 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsIPPhonePolicy.md @@ -1,127 +1,135 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsipphonepolicy -applicable: Skype for Business Online -title: Remove-CsTeamsIPPhonePolicy -author: tonywoodruff -ms.author: anwoodru -ms.reviewer: kponnus -manager: sandrao -schema: 2.0.0 ---- - -# Remove-CsTeamsIPPhonePolicy - -## SYNOPSIS - -Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams phone experiences. - -## SYNTAX - -``` -Remove-CsTeamsIPPhonePolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-Force] -``` - -## DESCRIPTION -Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams IP Phones experiences. - -Note: Ensure the policy is not assigned to any users or the policy deletion will fail. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -``` -This example shows the deletion of the policy CommonAreaPhone. - -## 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 -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the TeamsIPPhonePolicy that you would like to remove. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### Microsoft.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS \ No newline at end of file +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsipphonepolicy +applicable: Microsoft Teams +title: Remove-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Remove-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams phone experiences. + +## SYNTAX + +``` +Remove-CsTeamsIPPhonePolicy [[-Identity] ] + [-Confirm] + [-Force] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Remove-CsTeamsIPPhonePolicy cmdlet to remove a custom policy that's been created for controlling Teams IP Phones experiences. + +Note: Ensure the policy is not assigned to any users or the policy deletion will fail. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsIPPhonePolicy -Identity CommonAreaPhone +``` +This example shows the deletion of the policy CommonAreaPhone. + +## 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 +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the TeamsIPPhonePolicy that you would like to remove. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..a2b3b79a34 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,69 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Remove-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Remove-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams media connectivity policy. + +## SYNTAX + +``` +Remove-CsTeamsMediaConnectivityPolicy -Identity [] +``` + +## DESCRIPTION + +This cmdlet deletes a Teams media connectivity policy with the specified identity string. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMediaConnectivityPolicy -Identity "Test" +``` + +Deletes a Teams media connectivity policy with the identify of "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams media connectivity policy. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Set-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmediaconnectivitypolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..ac3f34c82e --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Remove-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +--- + +# Remove-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +``` +Remove-CsTeamsMeetingBrandingPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a previously created TeamsMeetingBrandingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should first assign a different policy to them. + +## EXAMPLES + +### Remove meeting branding policy +```powershell +PS C:\> Remove-CsTeamsMeetingBrandingPolicy -Identity "policy test" +``` + +In this example, the command deletes the `policy test` meeting branding policy from the organization's list of meeting branding policies and removes all assignments of this policy from users who have the policy assigned. + +## PARAMETERS + +### -Identity +Unique identifier of the policy to be deleted. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -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 +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md index 2f34dc8a42..3b8ee0ebd4 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingBroadcastPolicy.md @@ -1,16 +1,15 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsmeetingbroadcastpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: Remove-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- - # Remove-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS @@ -28,7 +27,6 @@ User-level policy for tenant admin to configure meeting broadcast behavior for t ## EXAMPLES - ## PARAMETERS ### -Confirm @@ -62,7 +60,7 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier for the policy to be removed. Policies can be configured at the global or per-user scopes. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) +Unique identifier for the policy to be removed. Policies can be configured at the global or per-user scopes. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a per-user policy, use syntax similar to this: -Identity SalesPolicy. @@ -112,8 +110,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -121,6 +118,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md index ec3abb2b98..afc4b6bca6 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingPolicy.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsmeetingpolicy -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingpolicy +applicable: Microsoft Teams title: Remove-CsTeamsMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTeamsMeetingPolicy @@ -120,11 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object @@ -132,4 +134,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..b813ff072b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsMeetingTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 - Deleting a meeting template permission policy + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Test_Policy +``` + +Deletes a policy instance with the Identity *Test_Policy*. + +### Example 2 - Deleting a policy when its assigned to a user + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +```powershell +Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsMeetingTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users. Assign a different policy to the users before removing +this one. Please refer to documentation. CorrelationId: 8698472b-f441-423b-8ee3-0469c7e07528 +At line:1 char:1 ++ Remove-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsM...ermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsMeetingTemplatePermissionPolicyCmdlet +``` + +## PARAMETERS + +### -Identity + +Identity of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) + +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md index ae7653a5ff..1529b4300f 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md @@ -1,19 +1,19 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsmessagingpolicy -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmessagingpolicy +applicable: Microsoft Teams title: Remove-CsTeamsMessagingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTeamsMessagingPolicy ## SYNOPSIS -Deletes a custom messaging policy. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. +Deletes a custom messaging policy. Teams messaging policies determine the features and capabilities that can be used in messaging within the teams client. ## SYNTAX @@ -110,11 +110,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object @@ -122,4 +124,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Remove-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md index 9eaa547e69..8cce132f98 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMobilityPolicy.md @@ -1,113 +1,113 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsmobilitypolicy -applicable: Skype for Business Online -title: Remove-CsTeamsMobilityPolicy -schema: 2.0.0 -manager: ritikag -ms.reviewer: ritikag ---- - - -# Remove-CsTeamsMobilityPolicy - -## SYNOPSIS -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -## SYNTAX - -``` -Remove-CsTeamsMobilityPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -The Remove-CsTeamsMobilityPolicy cmdlet lets an Admin delete a custom teams mobility policy that has been created. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Remove-CsTeamsMobilityPolicy -Identity SalesPolicy -``` - -Deletes a custom policy that has already been created in the organization. - -## 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 -``` - -### -Force -Suppresses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the client policy to be removed. To "remove" the global policy, use the following syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: -Identity "SalesDepartmentPolicy". You cannot use wildcards when specifying a policy Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -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.Rtc.Management.Xds.XdsIdentity - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Remove-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Remove-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +``` +Remove-CsTeamsMobilityPolicy [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The Remove-CsTeamsMobilityPolicy cmdlet lets an Admin delete a custom teams mobility policy that has been created. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMobilityPolicy -Identity SalesPolicy +``` + +Deletes a custom policy that has already been created in the organization. + +## 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 +``` + +### -Force +Suppresses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the client policy to be removed. To "remove" the global policy, use the following syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the properties in that policy will be reset to their default values.) To remove a per-user policy, use syntax similar to this: -Identity "SalesDepartmentPolicy". You cannot use wildcards when specifying a policy Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md similarity index 74% rename from skype/skype-ps/skype/Remove-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md index 966e6b8b7d..5192c02bc6 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsnetworkroamingpolicy -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnetworkroamingpolicy +applicable: Microsoft Teams title: Remove-CsTeamsNetworkRoamingPolicy author: TristanChen-msft ms.author: jiaych -ms.reviewer: +ms.reviewer: manager: mreddy schema: 2.0.0 --- @@ -20,7 +20,7 @@ Remove-CsTeamsNetworkRoamingPolicy allows IT Admins to delete policies for Netwo ## SYNTAX ``` -Remove-CsTeamsNetworkRoamingPolicy [-Tenant ] [[-Identity] ] +Remove-CsTeamsNetworkRoamingPolicy [[-Identity] ] [-Tenant ] [] ``` ## DESCRIPTION @@ -28,7 +28,7 @@ Deletes the Teams Network Roaming Policies configured for use in your organizati The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. -More on the impact of bit rate setting on bandwidth can be found [here](https://docs.microsoft.com/microsoftteams/prepare-network). +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). ## EXAMPLES @@ -70,6 +70,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 diff --git a/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md new file mode 100644 index 0000000000..172211f455 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsNotificationAndFeedsPolicy.md @@ -0,0 +1,109 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsnotificationandfeedspolicy +title: Remove-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS +Deletes an existing Teams Notification and Feeds Policy + +## SYNTAX + +```powershell +Remove-CsTeamsNotificationAndFeedsPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsNotificationAndFeedsPolicy +``` + +Remove an existing Notifications and Feeds Policy + +## 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 +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Remove-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md index 5c06be916c..669b830d56 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsPinnedApp.md +++ b/teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamspinnedapp -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamspinnedapp +applicable: Microsoft Teams title: Remove-CsTeamsPinnedApp schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTeamsPinnedApp @@ -17,12 +17,17 @@ ms.reviewer: As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## SYNTAX ``` -Remove-CsTeamsPinnedApp [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-Force] [-AsJob] +Remove-CsTeamsPinnedApp [[-Identity] ] + [-Confirm] + [-Force] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -30,7 +35,7 @@ Remove-CsTeamsPinnedApp [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## EXAMPLES @@ -40,14 +45,12 @@ Intentionally not provided ## 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsIdentity - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..6a51b6ae29 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Remove-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Remove-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +Remove-CsTeamsRecordingRollOutPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Removes a previously created CsTeamsRecordingRollOutPolicy. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy +``` + +In the example shown above, the command will delete the OrganizerPolicy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## 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 +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the CsTeamsRecordingRollOutPolicy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity SomePolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..e1a8839e41 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,107 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsroomvideoteleconferencingpolicy +title: Remove-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Deletes an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsRoomVideoTeleConferencingPolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## 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 + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..536843d50b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,126 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Remove-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Deletes an existing Teams shared calling routing policy instance. + +## SYNTAX + +``` +Remove-CsTeamsSharedCallingRoutingPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TeamsSharedCallingRoutingPolicy is used to configure shared calling. + +## EXAMPLES + +### EXAMPLE 1 +``` +Remove-CsTeamsSharedCallingRoutingPolicy -Identity "Seattle" +``` +The command shown in Example 1 deletes the Teams shared calling routing policy instance Seattle. + +### EXAMPLE 2 +``` +Get-CsTeamsSharedCallingRoutingPolicy -Filter "tag:*" | Remove-CsTeamsSharedCallingRoutingPolicy +``` +In Example 2, all Teams shared calling routing policies configured at the per-user scope are removed. To do this, the command first +calls the Get-CsTeamsSharedCallingRoutingPolicy cmdlet along with the Filter parameter; the filter value "tag:*" limits the +returned data to Teams shared calling routing policies configured at the per-user scope. Those per-user policies are then piped to +and removed by the Remove-CsTeamsSharedCallingRoutingPolicy cmdlet. + +## PARAMETERS + +### -Identity +Unique identifier assigned to the policy when it is created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) + +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..a86968dfd2 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md @@ -0,0 +1,102 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Remove-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: stepfitz +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Remove-CsTeamsShiftsConnection + +## SYNOPSIS + +This cmdlet deletes a Shifts connection. + +## SYNTAX + +``` +Remove-CsTeamsShiftsConnection -ConnectionId -InputObject [-PassThru] [] +``` + +## DESCRIPTION + +This cmdlet deletes a connection. All available connections can be found by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsShiftsConnection -ConnectionId 43cd0e23-b62d-44e8-9321-61cb5fcfae85 +``` + +Deletes the connection with ID `43cd0e23-b62d-44e8-9321-61cb5fcfae85`. + +## PARAMETERS + +### -ConnectionId + +The ID of the connection that you want to delete. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```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 + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md index a263972fe0..843cf262ce 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md @@ -5,7 +5,7 @@ title: Remove-CsTeamsShiftsConnectionInstance author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance schema: 2.0.0 --- @@ -23,7 +23,7 @@ Remove-CsTeamsShiftsConnectionInstance -ConnectorInstanceId [ -TeamId [] +```powershell +Remove-CsTeamsShiftsConnectionTeamMap -ConnectorInstanceId -TeamId -InputObject [-PassThru] [] ``` ## DESCRIPTION -This cmdlet removes the mapping between the Microsoft Teams team and WFM team. All team mappings can be found by running [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md). +This cmdlet removes the mapping between the Microsoft Teams team and WFM team. All team mappings can be found by running [Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap). ## EXAMPLES @@ -68,6 +68,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InputObject + +The identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: RemoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PassThru + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. + +```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). @@ -79,6 +111,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) +[Get-CsTeamsShiftsConnectionTeamMap](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionteammap) -[New-CsTeamsShiftsConnectionTeamMap](New-CsTeamsShiftsConnectionTeamMap.md) +[New-CsTeamsShiftsConnectionBatchTeamMap](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectionbatchteammap) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md index 3190cd278e..f7201e43a2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy +title: Remove-CsTeamsShiftsPolicy schema: 2.0.0 --- @@ -9,9 +10,9 @@ schema: 2.0.0 ## SYNOPSIS -Remove the TeamsShiftPolicy for a user. +The `Remove-CsTeamsShiftsPolicy` cmdlet removes a previously created TeamsShiftsPolicy. -Note: the command will return immediately, but the Teams application will not reflect the update immediately. The Teams application may need to be open for up to an hour before changes are reflected. +Note: A TeamsShiftsPolicy needs to be unassigned from all the users before it can be deleted. ## SYNTAX @@ -23,15 +24,15 @@ Remove-CsTeamsShiftsPolicy [-Identity] [] ### Example 1 ```powershell -PS C:\> Remove-CsTeamsShiftsPolicy -Identity IsaiahL +PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage ``` -In this example, the TeamsShiftsPolicy assigned to the user "IsaiahL" is removed. +In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". ## PARAMETERS ### -Identity -UserId or user's email id. +Policy instance name. ```yaml Type: XdsIdentity @@ -41,14 +42,13 @@ Applicable: Microsoft Teams Required: True Position: 1 Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsIdentity @@ -56,14 +56,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) -[New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) -[Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +[Set-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftspolicy) -[Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md b/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md index 21d483d5d5..5c64fec405 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md @@ -5,7 +5,7 @@ title: Remove-CsTeamsShiftsScheduleRecord author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsschedulerecord schema: 2.0.0 --- @@ -16,8 +16,21 @@ schema: 2.0.0 This cmdlet enqueues the clear schedule message. ## SYNTAX + +### RemoveExpanded (Default) +```powershell +Remove-CsTeamsShiftsScheduleRecord [-ClearSchedulingGroup] -EntityType -TeamId + [-DateRangeEndDate ] [-DateRangeStartDate ] [-DesignatedActorId ] + [-TimeZone ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] + [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] + [-Confirm] [] ``` -Remove-CsTeamsShiftsScheduleRecord -TeamId [[-DateRangeStartDate] ] -DateRangeEndDate -ClearSchedulingGroup -EntityType [[-DesignatedActorId] ] [] + +### Remove +```powershell +Remove-CsTeamsShiftsScheduleRecord -Body [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -124,6 +137,171 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Body +The request body. + +```yaml +Type: IClearScheduleRequest +Parameter Sets: Remove +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Used to return an object that represents the item being modified. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeZone +The Timezone parameter ensures that the shifts are displayed in the correct time zone based on your team's location. + +```yaml +Type: String +Parameter Sets: RemoveExpanded +Aliases: + +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). @@ -135,4 +313,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The parameters of start time, end time and designated actor ID are optional only when removing the schedule record of a linked team. ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..ec60890b7b --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,103 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliance +title: Remove-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Remove-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Remove-CsTeamsSurvivableBranchAppliance [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] + [-Confirm] [] +``` + +## 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 + +The Identity parameter is the unique identifier for the SBA. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..6aa49338fb --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,103 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssurvivablebranchappliancepolicy +title: Remove-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Remove-CsTeamsSurvivableBranchAppliancePolicy [-Identity] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## 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 + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..669d6bc872 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsTargetingPolicy.md @@ -0,0 +1,120 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy +title: Remove-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets removes a previously created CsTeamsTargetingPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsTargetingPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Deletes a previously created TeamsTargetingPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity StudentTagPolicy +``` + +In the example shown above, the command will delete the student tag policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## 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 + +Unique identifier for the teams meeting policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity StudentTagPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Set-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..28ecb18cd4 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy +title: Remove-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# Remove-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +Deletes an instance of TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsTemplatePermissionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +Deletes a policy instance with the Identity *Foobar*. + +### Example 2 +```powershell +PS >Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar +``` + +```output +Remove-CsTeamsTemplatePermissionPolicy : The policy "Foobar" is currently assigned to one or more users or groups. Ensure policy is not assigned before removing. Please refer to documentation. CorrelationId: 8622aac5-00c3-4071-b6d0-d070db8f663f +At line:1 char:1 ++ Remove-CsTeamsTemplatePermissionPolicy -Identity Foobar ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : NotSpecified: (:) [Remove-CsTeamsTemplatePermissionPolicy], PolicyRpException + + FullyQualifiedErrorId : ClientError,Microsoft.Teams.Policy.Administration.Cmdlets.Core.RemoveTeamsTemplatePermissionPolicyCmdlet +``` + +Attempting to delete a policy instance that is currently assigned to users will result in an error. Remove the assignment before attempting to delete it. + +## 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 +``` + +### -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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be deleted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Set-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md similarity index 75% rename from skype/skype-ps/skype/Remove-CsTeamsTranslationRule.md rename to teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md index 98861e7534..a1cc4fdcae 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsTranslationRule.md +++ b/teams/teams-ps/teams/Remove-CsTeamsTranslationRule.md @@ -1,107 +1,106 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamstranslationrule -applicable: Microsoft Teams -title: Remove-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# Remove-CsTeamsTranslationRule - -## SYNOPSIS -Cmdlet to remove an existing number manipulation rule (or list of rules). - -## SYNTAX - -``` -Remove-CsTeamsTranslationRule [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -You can use this cmdlet to remove an existing number manipulation rule (or list of rules). The rule can be used, for example, in the settings of your SBC (Set-CsOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System. - -## EXAMPLES - -### Example 1 -```powershell -Remove-CsTeamsTranslationRule -Identity AddPlus1 -``` - -This example removes the "AddPlus1" translation rule. As the rule can be used in some places, integrity check is preformed to ensure that the rule is not in use. If the rule is in use an error thrown with specifying which SBC use this rule. - -### Example 2 -```powershell -Get-CsTeamsTranslationRule -Filter 'tst*' | Remove-CsTeamsTranslationRule -``` - -This example removes all translation rules with Identifier starting with tst. - -## PARAMETERS - -### -Identity -Identifier of the rule. This parameter is required. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. 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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -[New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) - -[Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) - -[Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) - -[Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule +applicable: Microsoft Teams +title: Remove-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Remove-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to remove an existing number manipulation rule (or list of rules). + +## SYNTAX + +``` +Remove-CsTeamsTranslationRule [-Identity] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +You can use this cmdlet to remove an existing number manipulation rule (or list of rules). The rule can be used, for example, in the settings of your SBC (Set-CsOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System. + +## EXAMPLES + +### Example 1 +```powershell +Remove-CsTeamsTranslationRule -Identity AddPlus1 +``` + +This example removes the "AddPlus1" translation rule. As the rule can be used in some places, integrity check is preformed to ensure that the rule is not in use. If the rule is in use an error thrown with specifying which SBC use this rule. + +### Example 2 +```powershell +Get-CsTeamsTranslationRule -Filter 'tst*' | Remove-CsTeamsTranslationRule +``` + +This example removes all translation rules with Identifier starting with tst. + +## PARAMETERS + +### -Identity +Identifier of the rule. This parameter is required. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. 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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md index b51af7d6b0..118a64f812 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Remove-CsTeamsUnassignedNumberTreatment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Remove-CsTeamsUnassignedNumberTreatment @@ -15,11 +16,10 @@ schema: 2.0.0 ## SYNOPSIS Removes a treatment for how calls to an unassigned number range should be routed. - ## SYNTAX -```powershell -Remove-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] +``` +Remove-CsTeamsUnassignedNumberTreatment [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,7 +33,6 @@ Remove-CsTeamsUnassignedNumberTreatment -Identity MainAA ``` This example removes the treatment MainAA. - ## PARAMETERS ### -Identity @@ -45,23 +44,9 @@ Parameter Sets: (All) Aliases: Required: True +Position: 1 Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False +Accept pipeline input: ByPropertyName Accept wildcard characters: False ``` @@ -80,8 +65,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable The cmdlet is available in Teams PS module 2.5.1 or later. ## RELATED LINKS -[Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) + +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) -[New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) -[Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..e558236294 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,113 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Remove-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Remove-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to remove a Teams Update Management policy from the tenant. + +## SYNTAX + +``` +Remove-CsTeamsUpdateManagementPolicy [-Identity] [-Force] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Removes a Teams Update Management policy from the tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" +``` + +In this example, the policy "Campaign Policy" is being removed. + +## 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 +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy to be removed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..66afd2e7e6 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsVdiPolicy.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvdipolicy +title: Remove-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsVdiPolicy + +## SYNOPSIS +This CsTeamsVdiPolicy cmdlets removes a previously created TeamsVdiPolicy. + +## SYNTAX + +```powershell +Remove-CsTeamsVdiPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a previously created TeamsVdiPolicy. Any users with no explicitly assigned policies will then fall back to the default policy in the organization. You cannot delete the global policy from the organization. If you want to remove policies currently assigned to one or more users, you should assign a different policy to them before. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsMeetingPolicy -Identity RestrictedUserPolicy +``` + +In the example shown above, the command will delete the restricted user policy from the organization's list of policies and remove all assignments of this policy from users who have had the policy assigned. + +## 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 +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the teams Vdi policy to be removed. To remove the global policy, use this syntax: -Identity global. (Note that the global policy cannot actually be removed. Instead, all the policy properties will be reset to their default values.) To remove a custom policy, use this syntax: -Identity RestrictedUserPolicy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..a1a3852ec4 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,118 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy +title: Remove-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +ms.author: erocha +author: emmanuelrocha001 +manager: sonaggarwal +--- + +# Remove-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to delete an instance of TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +``` +Remove-CsTeamsVirtualAppointmentsPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes an instance of TeamsVirtualAppointmentsPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\>Remove-CsTeamsVirtualAppointmentsPolicy -Identity Foobar +``` + +Deletes a given policy instance with the Identity Foobar. + +## 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 +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md index c51691ad02..8458e8f402 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsVoiceApplicationsPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/remove-csteamsvoiceapplicationspolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy +title: Remove-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 --- @@ -18,8 +19,7 @@ Remove-CsTeamsVoiceApplicationsPolicy [-Identity] [-WhatIf] ``` ## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. - +TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES @@ -92,15 +92,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) -[Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) - -[Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) -[Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..c32aafbb08 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,125 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy +title: Remove-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Remove-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet deletes a Teams Workload Policy instance. + +## SYNTAX + +```powershell +Remove-CsTeamsWorkLoadPolicy [-Identity] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Remove-CsTeamsWorkLoadPolicy -Identity "Test" +``` + +Deletes a Teams Workload policy instance with the identity of "Test". + +## 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 + +Identity of the Teams Workload Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft Internal Use Only + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..fd2938fd43 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy +title: Remove-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +ms.author: arkozlov +manager: prashibadkur +author: artemiykozlov +--- + +# Remove-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to delete an instance of TeamsWorkLocationDetectionPolicy. + +## SYNTAX + +``` +Remove-CsTeamsWorkLocationDetectionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Deletes an instance of TeamsWorkLocationDetectionPolicy. The `Identity` parameter accepts the identity of the policy instance to delete. + +## EXAMPLES + +## EXAMPLES + +### Example 1 +```powershell +PS C:\>Remove-CsTeamsWorkLocationDetectionPolicy -Identity wld-policy +``` + +Deletes a given policy instance with the Identity wld-policy. + +## 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 +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Set-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/skype/skype-ps/skype/Remove-CsTenantDialPlan.md b/teams/teams-ps/teams/Remove-CsTenantDialPlan.md similarity index 58% rename from skype/skype-ps/skype/Remove-CsTenantDialPlan.md rename to teams/teams-ps/teams/Remove-CsTenantDialPlan.md index a89a4940b1..41c2e91c20 100644 --- a/skype/skype-ps/skype/Remove-CsTenantDialPlan.md +++ b/teams/teams-ps/teams/Remove-CsTenantDialPlan.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstenantdialplan -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan +applicable: Microsoft Teams title: Remove-CsTenantDialPlan schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,15 +18,14 @@ Use the `Remove-CsTenantDialPlan` cmdlet to remove a tenant dial plan. ## SYNTAX ``` -Remove-CsTenantDialPlan [-Tenant ] [-Identity] [-Force] [-WhatIf] [-Confirm] - [] +Remove-CsTenantDialPlan [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION The `Remove-CsTenantDialPlan` cmdlet removes an existing tenant dial plan (also known as a location profile). Tenant dial plans provide required information to allow Enterprise Voice users to make telephone calls. The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. -A tenant dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls. +A tenant dial plan determines such things as which normalization rules are applied. Removing a tenant dial plan also removes any associated normalization rules. If no tenant dial plan is assigned to an organization, the Global dial plan is used. @@ -40,20 +39,19 @@ Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 This example removes the Vt1TenantDialPlan2. - ## PARAMETERS ### -Identity The Identity parameter is the unique identifier of the tenant dial plan to remove. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Applicable: Microsoft Teams -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -66,41 +64,7 @@ The Confirm parameter prompts you for confirmation before the command is execute Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter suppresses any confirmation prompts that are otherwise displayed before the changes are made. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -116,7 +80,7 @@ The WhatIf parameter describes what would happen if you executed the command, wi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +Applicable: Microsoft Teams Required: False Position: Named @@ -126,13 +90,22 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ## NOTES +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. ## RELATED LINKS +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/skype/skype-ps/skype/Remove-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md similarity index 52% rename from skype/skype-ps/skype/Remove-CsTenantNetworkRegion.md rename to teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md index dae8620ba1..5e4b94b289 100644 --- a/skype/skype-ps/skype/Remove-CsTenantNetworkRegion.md +++ b/teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstenantnetworkregion -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion +applicable: Microsoft Teams title: Remove-CsTenantNetworkRegion schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -15,12 +15,9 @@ ms.reviewer: ## SYNOPSIS Use the `Remove-CsTenantNetworkRegion` cmdlet to remove a tenant network region. - ## SYNTAX - ``` -Remove-CsTenantNetworkRegion [-Tenant ] [-Identity] [-Force] [-WhatIf] - [-Confirm] [] +Remove-CsTenantNetworkRegion [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,7 +27,7 @@ A network region contains a collection of network sites. ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Remove-CsTenantNetworkRegion -Identity "RedmondRegion" ``` @@ -39,41 +36,11 @@ The command shown in Example 1 removes 'RedmondRegion'. ## 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 -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the network region to be removed. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) Aliases: @@ -84,19 +51,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network regions are being removed. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -122,16 +83,19 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsGlobalRelativeIdentity - ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) + +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) + +[Set-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion) diff --git a/skype/skype-ps/skype/Remove-CsTenantNetworkSite.md b/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md similarity index 54% rename from skype/skype-ps/skype/Remove-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Remove-CsTenantNetworkSite.md index 6a754c2f2e..a21acb85be 100644 --- a/skype/skype-ps/skype/Remove-CsTenantNetworkSite.md +++ b/teams/teams-ps/teams/Remove-CsTenantNetworkSite.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstenantnetworksite -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite +applicable: Microsoft Teams title: Remove-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,8 +18,7 @@ Use the `Remove-CsTenantNetworkSite` cmdlet to remove a tenant network site. ## SYNTAX ``` -Remove-CsTenantNetworkSite [-Tenant ] [-Identity] [-Force] [-WhatIf] - [-Confirm] [] +Remove-CsTenantNetworkSite [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,7 +28,7 @@ A network site represents a location where your organization has a physical venu ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Remove-CsTenantNetworkSite -Identity "site1" ``` @@ -38,41 +37,11 @@ The command shown in Example 1 removes 'site1'. ## 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 -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the network site to be removed. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) Aliases: @@ -83,19 +52,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network sites are being removed. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -121,16 +84,19 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsGlobalRelativeIdentity - ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) + +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) + +[Set-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite) diff --git a/skype/skype-ps/skype/Remove-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md similarity index 57% rename from skype/skype-ps/skype/Remove-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md index a68320a66e..2e8c9def13 100644 --- a/skype/skype-ps/skype/Remove-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstenantnetworksubnet -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet +applicable: Microsoft Teams title: Remove-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,8 +18,7 @@ Use the `Remove-CsTenantNetworkSubnet` cmdlet to remove a tenant network subnet. ## SYNTAX ``` -Remove-CsTenantNetworkSubnet [-Tenant ] [-Identity] [-Force] [-WhatIf] - [-Confirm] [] +Remove-CsTenantNetworkSubnet [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,7 +28,7 @@ IP subnets at the location where Teams endpoints can connect to the network must ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Remove-CsTenantNetworkSubnet -Identity "192.168.0.1" ``` @@ -38,41 +37,11 @@ The command shown in Example 1 removes '192.168.0.1'. ## 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 -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the network subnet to be removed. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) Aliases: @@ -83,19 +52,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network subnets are being removed. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -121,16 +84,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Rtc.Management.Xds.XdsGlobalRelativeIdentity - ## OUTPUTS -### System.Object ## NOTES ## RELATED LINKS +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) + +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) + +[Set-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet) diff --git a/skype/skype-ps/skype/Remove-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsTenantTrustedIPAddress.md rename to teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md index 80e56b8c6d..36eb4e2803 100644 --- a/skype/skype-ps/skype/Remove-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/teams/Remove-CsTenantTrustedIPAddress.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-cstenanttrustedipaddress -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenanttrustedipaddress +applicable: Microsoft Teams title: Remove-CsTenantTrustedIPAddress schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTenantTrustedIPAddress @@ -121,8 +121,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -131,6 +130,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md b/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md index bc057eae53..56d6d9bce2 100644 --- a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md +++ b/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-csusercallingdelegate +online version: https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Remove-CsUserCallingDelegate schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Remove-CsUserCallingDelegate @@ -33,7 +34,6 @@ Remove-CsUserCallingDelegate -Identity user1@contoso.com -Delegate user2@contoso ``` This example shows removing the delegate user2@contoso.com. - ## PARAMETERS ### -Delegate @@ -84,8 +84,8 @@ The specified user need to have the Microsoft Phone System license assigned. You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. ## RELATED LINKS -[Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) -[New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) -[Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md b/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md new file mode 100644 index 0000000000..8ba1f83cc3 --- /dev/null +++ b/teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserlicensegraceperiod +title: Remove-CsUserLicenseGracePeriod +description: This cmdlet expedites the delicensing operation for an account's assigned plans by removing the grace period, permanently deleting the assigned plans. +schema: 2.0.0 +ms.date: 02/01/2024 +author: serdarsoysal +ms.author: serdars +--- + +# Remove-CsUserLicenseGracePeriod + +## SYNOPSIS + +The `CsUserLicenseGracePeriod` cmdlet expedites the delicensing operation for the assigned plan(s) of a user/resource account by removing the grace period, permanently deleting the assigned plan(s). +Note that this cmdlet is to be used only by tenants with license resiliency enabled. (License resiliency is currently under private preview and not available for everyone.) + +## SYNTAX + +```powershell +Remove-CsUserLicenseGracePeriod +[-Identity] +[-Capability ] +-InputObject +[-Action ] +-Body +[-PassThru] +[-Force] +[-WhatIf] +[-Confirm] +[] +``` + +## DESCRIPTION + +The command removes the grace period of the assigned plan(s) against the specified user(s)/resource account(s), permanently deleting the plan(s). +Permanently deletes all/specified plans belonging to the user, which has a grace period assosciated with it. +Assigned plans with no subsequent grace period will see no change. + +If you want to verify the grace period of any assigned plan against a user, you can return that information by using this command: + +`Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354` + +## EXAMPLES + +### Example 1 + +```powershell +Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 +``` + +In Example 1, the command removes the grace period of all assigned plan(s) against the specified user ID, marking the subsequent assigned plan(s) as deleted. Assigned plans with no subsequent grace period will see no change. + +### Example 2 + +```powershell +Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -Capability 'MCOEV,MCOMEETADD' +``` + +In Example 2, the capability specified refers to plans assigned to the user(s) under AssignedPlans. The command removes the grace period of the specified assigned plans, marking the subsequent plan(s) as deleted. + +## PARAMETERS + +### -Identity + +Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName,ByValue) +Accept wildcard characters: False +``` + +### -Capability + +Denotes the plan(s) assigned to the specified user, which are to be permanently deleted if they are currently serving their grace period. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName,ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Returns the results of the command. By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +The Identity parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Action + +Used to specify which action should be taken. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Body + +Specifies the body of the request. + +```yaml +Type: IUserDelicensingAccelerationPatch +Parameter Sets: (All) +Aliases: + +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md similarity index 77% rename from skype/skype-ps/skype/Remove-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md index c185153c6c..9344dcff1d 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/Remove-CsVideoInteropServiceProvider.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/remove-csvideointeropserviceprovider -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/remove-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Remove-CsVideoInteropServiceProvider schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsVideoInteropServiceProvider @@ -19,8 +19,12 @@ Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join T ## SYNTAX ``` -Remove-CsVideoInteropServiceProvider [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-Force] - [-AsJob] +Remove-CsVideoInteropServiceProvider [[-Identity] ] + [-Confirm] + [-Force] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -48,14 +52,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Remove-SharedWithTeam.md b/teams/teams-ps/teams/Remove-SharedWithTeam.md new file mode 100644 index 0000000000..e143bc6c3c --- /dev/null +++ b/teams/teams-ps/teams/Remove-SharedWithTeam.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/remove-sharedwithteam +title: Remove-SharedWithTeam +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: dedaniel, robharad +--- + +# Remove-SharedWithTeam + +## SYNOPSIS +This cmdlet supports unsharing a channel with a team. + +## SYNTAX +```PowerShell +Remove-SharedWithTeam -HostTeamId -ChannelId -SharedWithTeamId [] +``` + +## DESCRIPTION +This cmdlet supports unsharing a channel with a team. + +## EXAMPLES + +### Example 1 +```PowerShell +Remove-SharedWithTeam -HostTeamId 126b90a5-e65a-4fef-98e3-d9b49f4acf12 -ChannelId 19:cUfyYYw3h_t-1KG8-WkvVa7KLEsIx-JHmyeG43VJojg1@thread.tacv2 +-SharedWithTeam d2aad370-c6ca-438b-b4d7-05f0aa911a7b +``` + +Unshares a channel with a team. + +## PARAMETERS + +### -HostTeamId +Team ID of the host team (Group ID). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ChannelId +Thread ID of the shared channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SharedWithTeamId +Team ID of the shared with team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +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/?LinkID=113216). + +## INPUTS + +### HostTeamId, ChannelId, SharedWithTeamId + +## OUTPUTS + +## NOTES + +## RELATED LINKS +[Remove-Team](https://learn.microsoft.com/powershell/module/teams/remove-team) diff --git a/teams/teams-ps/teams/Remove-Team.md b/teams/teams-ps/teams/Remove-Team.md index f001fbb584..b379c99308 100644 --- a/teams/teams-ps/teams/Remove-Team.md +++ b/teams/teams-ps/teams/Remove-Team.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-team +online version: https://learn.microsoft.com/powershell/module/teams/remove-team +title: Remove-Team schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -12,10 +13,10 @@ ms.reviewer: ## SYNOPSIS -This cmdlet deletes a specified Team from Microsoft Teams. +This cmdlet deletes a specified Team from Microsoft Teams. NOTE: The associated Office 365 Unified Group will also be removed. - + ## SYNTAX ``` @@ -24,7 +25,7 @@ Remove-Team -GroupId [] ## DESCRIPTION -Removes a specified team via GroupID and all its associated components, like O365 Unified Group... +Removes a specified team via GroupID and all its associated components, like O365 Unified Group... ## EXAMPLES @@ -51,8 +52,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -62,4 +62,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[New-Team]() +[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) diff --git a/teams/teams-ps/teams/Remove-TeamChannel.md b/teams/teams-ps/teams/Remove-TeamChannel.md index 74ed2c7f29..9ab0da2703 100644 --- a/teams/teams-ps/teams/Remove-TeamChannel.md +++ b/teams/teams-ps/teams/Remove-TeamChannel.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-teamchannel +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchannel +title: Remove-TeamChannel schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -15,7 +16,7 @@ ms.reviewer: Delete a channel. This will not delete content in associated tabs. -Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. +Note: The channel will be "soft deleted", meaning the contents are not permanently deleted for a time. So a subsequent call to Add-TeamChannel using the same channel name will fail if enough time has not passed. ## SYNTAX @@ -27,7 +28,7 @@ Remove-TeamChannel -GroupId -DisplayName [] ## DESCRIPTION > [!IMPORTANT] -> Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here . +> Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here `https://www.poshtestgallery.com/packages/MicrosoftTeams`. ## EXAMPLES @@ -69,8 +70,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Remove-TeamChannelUser.md b/teams/teams-ps/teams/Remove-TeamChannelUser.md index 7c63f3924c..5593e0c440 100644 --- a/teams/teams-ps/teams/Remove-TeamChannelUser.md +++ b/teams/teams-ps/teams/Remove-TeamChannelUser.md @@ -1,18 +1,21 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-teamchanneluser +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamchanneluser +title: Remove-TeamChannelUser schema: 2.0.0 --- # Remove-TeamChannelUser ## SYNOPSIS -Note: the command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. +> [!Note] +> The command will return immediately, but the Teams application will not reflect the update immediately, please refresh the members page to see the update. -To turn an existing Owner into an Member, specify role parameter as Owner. +To turn an existing Owner into a Member, specify role parameter as Owner. -Note: last owner cannot be removed from the private channel. +> [!Note] +> Last owner cannot be removed from the private channel. ## SYNTAX @@ -23,7 +26,8 @@ Remove-TeamChannelUser -GroupId -DisplayName -User [- ## DESCRIPTION -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://docs.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://docs.microsoft.com/microsoftteams/teams-powershell-release-notes). +> [!Note] +> This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -65,7 +69,7 @@ Accept wildcard characters: False ``` ### -User -User's UPN (user principal name - e.g. +User's email address (e.g. johndoe@example.com) ```yaml diff --git a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md b/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md index b1927bc455..01e2e675e0 100644 --- a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md +++ b/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/connect-microsoftteams +online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams +title: Remove-TeamTargetingHierarchy schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -17,7 +18,7 @@ Removes the tenant's hierarchy. ### Remove (Default) ``` -Remove-TeamTargetingHierarchy +Remove-TeamTargetingHierarchy [-ApiVersion ] [] ``` ## DESCRIPTION @@ -30,9 +31,27 @@ Removes the tenant's hierarchy. PS C:\> Remove-TeamTargetingHierarchy ``` +## PARAMETERS + +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: false +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -42,4 +61,4 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[Set-TeamTargetingHierarchy](https://docs.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) +[Set-TeamTargetingHierarchy](https://learn.microsoft.com/powershell/module/teams/set-teamtargetinghierarchy) diff --git a/teams/teams-ps/teams/Remove-TeamUser.md b/teams/teams-ps/teams/Remove-TeamUser.md index 19d37812f7..1bc56b8ac7 100644 --- a/teams/teams-ps/teams/Remove-TeamUser.md +++ b/teams/teams-ps/teams/Remove-TeamUser.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-teamuser +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamuser +title: Remove-TeamUser schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -92,8 +93,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Remove-TeamsApp.md b/teams/teams-ps/teams/Remove-TeamsApp.md index 6060728d60..a7462e20f9 100644 --- a/teams/teams-ps/teams/Remove-TeamsApp.md +++ b/teams/teams-ps/teams/Remove-TeamsApp.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-teamsapp +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsapp +title: Remove-TeamsApp schema: 2.0.0 --- @@ -44,14 +45,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md index 7cac8adf13..36234579ef 100644 --- a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/remove-teamsappinstallation +online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsappinstallation +title: Remove-TeamsAppInstallation schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -30,7 +31,7 @@ Remove-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -Use ## DESCRIPTION Removes a Teams App installed in Microsoft Teams. -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://docs.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://docs.microsoft.com/microsoftteams/teams-powershell-release-notes). +Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -113,6 +114,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsApplicationAccessPolicy.md b/teams/teams-ps/teams/Set-CsApplicationAccessPolicy.md new file mode 100644 index 0000000000..5fe3b54419 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsApplicationAccessPolicy.md @@ -0,0 +1,157 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csapplicationaccesspolicy +applicable: Microsoft Teams +title: Set-CsApplicationAccessPolicy +schema: 2.0.0 +manager: zhengni +author: frankpeng7 +ms.author: frpeng +ms.reviewer: +--- + +# Set-CsApplicationAccessPolicy + +## SYNOPSIS + +Modifies an existing application access policy. + +## SYNTAX + +```powershell +Set-CsApplicationAccessPolicy [-AppIds ] [-Description ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This cmdlet modifies an existing application access policy. + +## EXAMPLES + +### Add new app ID to the policy + +```powershell +PS C:\> Set-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds @{Add="5817674c-81d9-4adb-bfb2-8f6a442e4622"} +``` + +The command shown above adds a new app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" to the per-user application access policy ASimplePolicy. + +### Remove app IDs from the policy + +```powershell +PS C:\> Set-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds @{Remove="5817674c-81d9-4adb-bfb2-8f6a442e4622"} +``` + +The command shown above removes the app ID "5817674c-81d9-4adb-bfb2-8f6a442e4622" from the per-user application access policy ASimplePolicy. + +## PARAMETERS + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppIds + +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free format text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Grant-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Get-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) +[Remove-CsApplicationAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csapplicationaccesspolicy) diff --git a/skype/skype-ps/skype/Set-CsApplicationMeetingConfiguration.md b/teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsApplicationMeetingConfiguration.md rename to teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md index 582916ebcb..c6c427fe87 100644 --- a/skype/skype-ps/skype/Set-CsApplicationMeetingConfiguration.md +++ b/teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-CsApplicationMeetingConfiguration +online version: https://learn.microsoft.com/powershell/module/teams/set-CsApplicationMeetingConfiguration applicable: Teams title: Set-CsApplicationMeetingConfiguration schema: 2.0.0 @@ -62,7 +62,7 @@ However, you can use the following syntax to retrieve the global settings: -Iden ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -77,7 +77,7 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi ```yaml Type: PSObject Parameter Sets: Instance -Aliases: +Aliases: Applicable: Teams Required: False @@ -89,7 +89,7 @@ Accept wildcard characters: False ### -AllowRemoveParticipantAppIds -A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). +A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in). ```yaml Type: PSListModifier @@ -109,7 +109,7 @@ Suppresses the display of any non-fatal error message that might occur when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Teams Required: False @@ -152,21 +152,21 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types None. The `Set-CsApplicationMeetingConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Output types The `Set-CsApplicationMeetingConfiguration` cmdlet does not return any objects or values. ## NOTES ## RELATED LINKS -[Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) +[Get-CsApplicationMeetingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csapplicationmeetingconfiguration) diff --git a/skype/skype-ps/skype/Set-CsAutoAttendant.md b/teams/teams-ps/teams/Set-CsAutoAttendant.md similarity index 86% rename from skype/skype-ps/skype/Set-CsAutoAttendant.md rename to teams/teams-ps/teams/Set-CsAutoAttendant.md index f49dc777cd..f1241561ad 100644 --- a/skype/skype-ps/skype/Set-CsAutoAttendant.md +++ b/teams/teams-ps/teams/Set-CsAutoAttendant.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csautoattendant -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csautoattendant +applicable: Microsoft Teams title: Set-CsAutoAttendant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsAutoAttendant @@ -24,8 +24,6 @@ Set-CsAutoAttendant -Instance [-Tenant ] [] ## DESCRIPTION The Set-CsAutoAttendant cmdlet lets you modify the properties of an auto attendant. For example, you can change the operator, the greeting, or the menu prompts. - - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -127,7 +125,7 @@ You can retrieve an object reference to an existing AA by using the Get-CsAutoAt Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -142,7 +140,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -152,31 +150,28 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable`. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant The Set-CsAutoAttendant cmdlet accepts a `Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant` object as the Instance parameter. - ## OUTPUTS ### Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant The modified instance of the `Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant` object. - ## NOTES ## RELATED LINKS -[New-CsAutoAttendant](New-CsAutoAttendant.md) - -[Get-CsAutoAttendant](Get-CsAutoAttendant.md) +[New-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/new-csautoattendant) -[Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) -[Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) -[Update-CsAutoAttendant](Update-CsAutoAttendant.md) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) +[Update-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/update-csautoattendant) diff --git a/teams/teams-ps/teams/Set-CsCallQueue.md b/teams/teams-ps/teams/Set-CsCallQueue.md new file mode 100644 index 0000000000..8f93fc3973 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsCallQueue.md @@ -0,0 +1,1727 @@ +--- +external help file: Microsoft.Rtc.Management.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cscallqueue +applicable: Microsoft Teams +title: Set-CsCallQueue +schema: 2.0.0 +ms.reviewer: +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsCallQueue + +## SYNOPSIS +Updates a Call Queue in your Skype for Business Online or Teams organization. + +## SYNTAX + +``` +Set-CsCallQueue -Identity [-AgentAlertTime ] [-AllowOptOut ] [-ChannelId ] [-ChannelUserObjectId ] [-ShiftsTeamId ] [-ShiftsSchedulingGroupId ] [-DistributionLists ] [-MusicOnHoldAudioFileId ] [-Name ] [-OboResourceAccountIds ] [-OverflowAction ] [-OverflowActionTarget ] [-OverflowActionCallPriority ] [-OverflowThreshold ] [-RoutingMethod ] [-TimeoutAction ] [-Tenant ] [-TimeoutActionTarget ] [-TimeoutActionCallPriority ] [-TimeoutThreshold ] [-NoAgentApplyTo ] [-NoAgentAction ] [-NoAgentActionTarget ] [-NoAgentActionCallPriority ] [-UseDefaultMusicOnHold ] [-WelcomeMusicAudioFileId ] [-PresenceBasedRouting ] [-ConferenceMode ] [-Users ] [-LanguageId ] [-LineUri ] [-OverflowDisconnectTextToSpeechPrompt ][-OverflowDisconnectAudioFilePrompt ] [-OverflowRedirectPersonTextToSpeechPrompt ] [-OverflowRedirectPersonAudioFilePrompt ] [-OverflowRedirectVoiceAppTextToSpeechPrompt ] [-OverflowRedirectVoiceAppAudioFilePrompt ] [-OverflowRedirectPhoneNumberTextToSpeechPrompt ] [-OverflowRedirectPhoneNumberAudioFilePrompt ] [-OverflowRedirectVoicemailTextToSpeechPrompt ] [-OverflowRedirectVoicemailAudioFilePrompt ] [-OverflowSharedVoicemailTextToSpeechPrompt ] [-OverflowSharedVoicemailAudioFilePrompt ] [-EnableOverflowSharedVoicemailTranscription ] [-EnableOverflowSharedVoicemailSystemPromptSuppression ] [-TimeoutDisconnectTextToSpeechPrompt ][-TimeoutDisconnectAudioFilePrompt ] [-TimeoutRedirectPersonTextToSpeechPrompt ] [-TimeoutRedirectPersonAudioFilePrompt ] [-TimeoutRedirectVoiceAppTextToSpeechPrompt ] [-TimeoutRedirectVoiceAppAudioFilePrompt ] [-TimeoutRedirectPhoneNumberTextToSpeechPrompt ][-TimeoutRedirectPhoneNumberAudioFilePrompt ] [-TimeoutRedirectVoicemailTextToSpeechPrompt ] [-TimeoutRedirectVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-TimeoutSharedVoicemailTextToSpeechPrompt ] [-TimeoutSharedVoicemailAudioFilePrompt ] [-EnableTimeoutSharedVoicemailTranscription ] [-EnableTimeoutSharedVoicemailSystemPromptSuppression ] [-NoAgentDisconnectTextToSpeechPrompt ][-NoAgentDisconnectAudioFilePrompt ] [-NoAgentRedirectPersonTextToSpeechPrompt ] [-NoAgentRedirectPersonAudioFilePrompt ] [-NoAgentRedirectVoiceAppTextToSpeechPrompt ] [-NoAgentRedirectVoiceAppAudioFilePrompt ] [-NoAgentRedirectPhoneNumberTextToSpeechPrompt ] [-NoAgentRedirectPhoneNumberAudioFilePrompt ] [-NoAgentRedirectVoicemailTextToSpeechPrompt ] [-NoAgentRedirectVoicemailAudioFilePrompt ] [-NoAgentSharedVoicemailTextToSpeechPrompt ] [-NoAgentSharedVoicemailAudioFilePrompt ] [-EnableNoAgentSharedVoicemailTranscription ] [-EnableNoAgentSharedVoicemailSystemPromptSuppression ] [AuthorizedUsers ] [-HideAuthorizedUsers ] [-WelcomeTextToSpeechPrompt ] [-IsCallbackEnabled ] [-CallbackRequestDtmf ] [-WaitTimeBeforeOfferingCallbackInSecond ] [-NumberOfCallsInQueueBeforeOfferingCallback ] [-CallToAgentRatioThresholdBeforeOfferingCallback ] [-CallbackOfferAudioFilePromptResourceId ] [-CallbackOfferTextToSpeechPrompt ] [-CallbackEmailNotificationTarget ] [-ServiceLevelThresholdResponseTimeInSecond [Int16> ] [-ComplianceRecordingForCallQueueTemplateId ] [-TextAnnouncementForCR ] [-CustomAudioFileAnnouncementForCR ] [-TextAnnouncementForCRFailure ] [-CustomAudioFileAnnouncementForCRFailure ] [-ShouldOverwriteCallableChannelProperty ] [-SharedCallQueueHistoryTemplateId ] [] +``` + +## DESCRIPTION + +Set-CsCallQueue cmdlet provides a way for you to modify the properties of an existing Call Queue; for example, you can change the name for the Call Queue, the distribution lists associated with the Call Queue, or the welcome audio file. + +The Set-CsCallQueue cmdlet may suggest additional steps required to complete the Call Queue setup. + +Note that this cmdlet is in the Skype for Business Online PowerShell module and also affects Teams. The reason the "Applies To:" is stated as Skype for Business Online is because it must match the actual module name of the cmdlet. To learn how this cmdlet is used with Skype for Business Online and Teams, see https://learn.microsoft.com/microsoftteams/create-a-phone-system-call-queue. + +> [!CAUTION] +> The following configuration parameters are currently only available in PowerShell and do not appear in Teams admin center. Saving a call queue configuration through Teams admin center will _remove_ any of these configured items. +> +> - -HideAuthorizedUsers +> - -OverflowActionCallPriority +> - -OverflowRedirectPersonTextToSpeechPrompt +> - -OverflowRedirectPersonAudioFilePrompt +> - -OverflowRedirectVoicemailTextToSpeechPrompt +> - -OverflowRedirectVoicemailAudioFilePrompt +> - -TimeoutActionCallPriority +> - -TimeoutRedirectPersonTextToSpeechPrompt +> - -TimeoutRedirectPersonAudioFilePrompt +> - -TimeoutRedirectVoicemailTextToSpeechPrompt +> - -TimeoutRedirectVoicemailAudioFilePrompt +> - -NoAgentActionCallPriority +> - -NoAgentRedirectPersonTextToSpeechPrompt +> - -NoAgentRedirectPersonAudioFilePrompt +> - -NoAgentRedirectVoicemailTextToSpeechPrompt +> - -NoAgentRedirectVoicemailAudioFilePrompt +> +> The following configuration parameters will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time. +> +> - -ShiftsTeamId +> - -ShiftsSchedulingGroupId +> - -ComplianceRecordingForCallQueueTemplateId +> - -TextAnnouncementForCR +> - -CustomAudioFileAnnouncementForCR +> - -TextAnnouncementForCRFailure +> - -CustomAudioFileAnnouncementForCRFailure +> - -SharedCallQueueHistoryTemplateId +> +> [Nesting Auto attendants and Call queues](/microsoftteams/plan-auto-attendant-call-queue#nested-auto-attendants-and-call-queues) without a resource account isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. If you nest an Auto attendant or Call queue without a resource account, authorized users can't edit the auto attendant or call queue. +> +> Authorized users can't edit call flows with call priorities at this time. + + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -UseDefaultMusicOnHold $true +``` + +This example updates the Call Queue with identity e7e00636-47da-449c-a36b-1b3d6ee04440 by making it use the default music on hold. + +### -------------------------- Example 2 -------------------------- +``` +Set-CsCallQueue -Identity e7e00636-47da-449c-a36b-1b3d6ee04440 -DistributionLists @("8521b0e3-51bd-4a4b-a8d6-b219a77a0a6a", "868dccd8-d723-4b4f-8d74-ab59e207c357") -MusicOnHoldAudioFileId $audioFile.Id +``` + +This example updates the Call Queue with new distribution lists and references a new music on hold audio file using the audio file ID from the stored variable $audioFile created with the [Import-CsOnlineAudioFile cmdlet](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) + +## PARAMETERS + +### -Identity +PARAMVALUE: Guid + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AgentAlertTime +The AgentAlertTime parameter represents the time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 15 and 180 seconds (3 minutes), inclusive. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 30 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOptOut +The AllowOptOut parameter indicates whether or not agents can opt in or opt out from taking calls from a Call Queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DistributionLists +The DistributionLists parameter lets you add all the members of the distribution lists to the Call Queue. This is a list of distribution list GUIDs. A service wide configurable maximum number of DLs per Call Queue are allowed. Only the first N (service wide configurable) agents from all distribution lists combined are considered for accepting the call. Nested DLs are supported. O365 Groups can also be used to add members to the Call Queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldAudioFileId +The MusicOnHoldFileContent parameter represents music to play when callers are placed on hold. This is the unique identifier of the audio file. This parameter is required if the UseDefaultMusicOnHold parameter is not specified. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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 Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OboResourceAccountIds +The OboResourceAccountIds parameter lets you add resource account with phone number to the Call Queue. The agents in the Call Queue will be able to make outbound calls using the phone number on the resource accounts. This is a list of resource account GUIDs. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowAction +The OverflowAction parameter designates the action to take if the overflow threshold is reached. The OverflowAction property must be set to one of the following values: DisconnectWithBusy, Forward, Voicemail, and SharedVoicemail. The default value is DisconnectWithBusy. + +PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: DisconnectWithBusy +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionTarget +The OverflowActionTarget parameter represents the target of the overflow action. If the OverFlowAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the OverflowAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this parameter is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the OverflowAction is set to Forward, and the OverflowActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowThreshold +The OverflowThreshold parameter defines the number of calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 200, inclusive. A value of 0 causes calls not to reach agents and the overflow action to be taken immediately. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoutingMethod +The RoutingMethod defines how agents will be called in a Call Queue. If the routing method is set to Serial, then agents will be called one at a time. If the routing method is set to Attendant, then agents will be called in parallel. If routing method is set to RoundRobin, the agents will be called using Round Robin strategy so that all agents share the call-load equally. If routing method is set to LongestIdle, the agents will be called based on their idle time, i.e., the agent that has been idle for the longest period will be called. + +PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Attendant +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutAction +The TimeoutAction parameter defines the action to take if the timeout threshold is reached. The TimeoutAction property must be set to one of the following values: Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Disconnect. + +PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionTarget +The TimeoutActionTarget represents the target of the timeout action. If the TimeoutAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the TimeoutAction is set to SharedVoicemail, this parameter must be set to an Office 365 Group ID. Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the TimeoutAction is set to Forward, and the TimeoutActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutThreshold +The TimeoutThreshold parameter defines the time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter. +The TimeoutThreshold can be any integer value between 0 and 2700 seconds (inclusive), and is rounded to the nearest 15th interval. For example, if set to 47 seconds, then it is rounded down to 45. If set to 0, welcome music is played, and then the timeout action will be taken. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: 1200 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentApplyTo +The NoAgentApplyTo parameter defines if the NoAgentAction applies to calls already in queue and new calls arriving to the queue, or only new calls that arrive once the No Agents condition occurs. The default value is AllCalls. + +PARAMVALUE: AllCalls | NewCalls + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentAction +The NoAgentAction parameter defines the action to take if the no agents condition is reached. The NoAgentAction property must be set to one of the following values: Queue, Disconnect, Forward, Voicemail, and SharedVoicemail. The default value is Queue. + +PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disconnect +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionTarget +The NoAgentActionTarget represents the target of the no agent action. If the NoAgentAction is set to Forward, this parameter must be set to a Guid or a telephone number with a mandatory 'tel:' prefix. If the NoAgentAction is set to SharedVoicemail, this parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security). Otherwise, this field is optional. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentActionCallPriority +_Saving a call queue configuration through Teams admin center will reset the priority to 3 - Normal / Default._ + +If the NoAgentAction is set to Forward, and the NoAgentActionTarget is set to an Auto attendant or Call queue resource account Guid, this parameter must be set to indicate the priority that will be assigned to the call. Otherwise, this parameter is not applicable. + +PARAMVALUE: 1 | 2 | 3 | 4 | 5 +- 1 = Very High +- 2 = High +- 3 = Normal / Default +- 4 = Low +- 5 = Very Low + +> [!IMPORTANT] +> Call priorities isn't currently supported for [Authorized users](/microsoftteams/aa-cq-authorized-users-plan) in Queues App. Authorized users will not be able to edit call flows with priorities. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseDefaultMusicOnHold +The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the default music on hold. This parameter cannot be specified together with MusicOnHoldAudioFileId. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeMusicAudioFileId +The WelcomeMusicAudioFileId parameter represents the audio file to play when callers are connected with the Call Queue. This is the unique identifier of the audio file. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PresenceBasedRouting +The PresenceBasedRouting parameter indicates whether or not presence based routing will be applied while call being routed to Call Queue agents. When set to False, calls will be routed to agents who have opted in to receive calls, regardless of their presence state. When set to True, opted-in agents will receive calls only when their presence state is Available. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConferenceMode +The ConferenceMode parameter indicates whether or not Conference mode will be applied on calls for this Call queue. Conference mode significantly reduces the amount of time it takes for a caller to be connected to an agent, after the agent accepts the call. The following bullet points detail the difference between both modes: + +- Conference Mode Disabled: CQ call is presented to agent. Agent answers and media streams are setup. Based on geographic location of the CQ call and agent, there may be a slight delay in setting up the media streams which may result in some dead air and the first part of the conversation being cut off. + +- Conference Mode Enabled: CQ call is put into conference. Agent answers and is brought into conference. Media streams are already setup when agent is brought into conference thus no dead air, and first bit of conversation will not be cut off. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users +The User parameter lets you add agents to the Call Queue. This parameter expects a list of user unique identifiers (GUID). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LanguageId +The LanguageId parameter indicates the language that is used to play shared voicemail prompts. This parameter becomes a required parameter If either OverflowAction or TimeoutAction is set to SharedVoicemail. + +You can query the supported languages using the Get-CsAutoAttendantSupportedLanguage cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri +This parameter is reserved for Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectAudioFilePrompt +The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowDisconnectTextToSpeechPrompt +The OverflowDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppAudioFilePrompt +The OverflowRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoiceAppTextToSpeechPrompt +The OverflowRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberAudioFilePrompt +The OverflowRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectPhoneNumberTextToSpeechPrompt +The OverflowRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The OverflowRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to overflow. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailTextToSpeechPrompt +The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverflowSharedVoicemailAudioFilePrompt +The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on overflow. This parameter becomes a required parameter when OverflowAction is SharedVoicemail and OverflowSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailTranscription +The EnableOverflowSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on overflow. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOverflowSharedVoicemailSystemPromptSuppression +The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectAudioFilePrompt +The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutDisconnectTextToSpeechPrompt +The TimeoutDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonAudioFilePrompt +The TimeoutRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoiceAppTextToSpeechPrompt +The TimeoutRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberAudioFilePrompt +The TimeoutRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectPhoneNumberTextToSpeechPrompt +The TimeoutRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TimeoutRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to timeout. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailTextToSpeechPrompt +The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TimeoutSharedVoicemailAudioFilePrompt +The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on timeout. This parameter becomes a required parameter when TimeoutAction is SharedVoicemail and TimeoutSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailTranscription +The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on timeout. This parameter is only applicable when TimeoutAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTimeoutSharedVoicemailSystemPromptSuppression +The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when OverflowAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectTextToSpeechPrompt +The NoAgentDisconnectTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentDisconnectAudioFilePrompt +The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being disconnected due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPersonAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectPersonAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person in the organization due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppTextToSpeechPrompt +The NoAgentRedirectVoiceAppsTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoiceAppAudioFilePrompt +The NoAgentRedirectVoiceAppAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a voice application due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberTextToSpeechPrompt +The NoAgentRedirectPhoneNumberTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectPhoneNumberAudioFilePrompt +The NoAgentRedirectPhoneNumberAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to an external PSTN phone number due to no agents. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailTextToSpeechPrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentRedirectVoicemailAudioFilePrompt +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The NoAgentRedirectVoiceMailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is played to the caller when being redirected to a person's voicemail due to no agent. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailTextToSpeechPrompt +The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailAudioFilePrompt is null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoAgentSharedVoicemailAudioFilePrompt +The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identifier for the Audio file prompt which is to be played as a greeting to the caller when transferred to shared voicemail on no agents. This parameter becomes a required parameter when NoAgentAction is SharedVoicemail and NoAgentSharedVoicemailTextToSpeechPrompt is null. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailTranscription +The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on transcription for voicemails left by a caller on no agents. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableNoAgentSharedVoicemailSystemPromptSuppression +The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to turn off the default voicemail system prompts. This parameter is only applicable when NoAgentAction is set to SharedVoicemail. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelId +Id of the channel to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelUserObjectId +The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). This is the GUID of one of the owners of the team that the channel belongs to. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsTeamId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Team containing the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftsSchedulingGroupId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +Id of the Scheduling Group to connect a call queue to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthorizedUsers +This is a list of GUIDs for users who are authorized to make changes to this call queue. The users must also have a TeamsVoiceApplications policy assigned. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideAuthorizedUsers +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +This is a list of GUIDs of authorized users who should not appear on the list of supervisors for the agents who are members of this queue. The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WelcomeTextToSpeechPrompt +This parameter indicates which Text-to-Speech (TTS) prompt is played when callers are connected to the Call Queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsCallbackEnabled + +The IsCallbackEnabled parameter is used to turn on/off callback. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackRequestDtmf + +The DTMF touch-tone key the caller will be told to press to select callback. The CallbackRequestDtmf must be set to one of the following values: + +- Tone0 to Tone9 - Corresponds to DTMF tones from 0 to 9. +- ToneStar - Corresponds to DTMF tone *. +- TonePound - Corresponds to DTMF tone #. + +This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaitTimeBeforeOfferingCallbackInSecond + +The number of seconds a call must wait before becoming eligible for callback. This condition applies to calls at the front of the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NumberOfCallsInQueueBeforeOfferingCallback + +The number of calls in queue before a call becomes eligible for callback. This condition applies to calls arriving at the call queue. Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallToAgentRatioThresholdBeforeOfferingCallback + +The ratio of calls to agents that must be in queue before a call becomes eligible for callback. This conditon applies to calls arriving at the call queue. Minimum value of one (1). Set to null ($null) to disable this condition. + +At least one of `-WaitTimeBeforeOfferingCallbackInSecond`, `-NumberOfCallsInQueueBeforeOfferingCallback`, or `-CallToAgentRatioThresholdBeforeOfferingCallback` must be set to a value other than null when `-IsCallbackEnabled` is `True`. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferAudioFilePromptResourceId + +The CallbackOfferAudioFilePromptResourceId parameter indicates the unique identifier for the Audio file prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferTextToSpeechPrompt`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackOfferTextToSpeechPrompt + +The CallbackOfferTextToSpeechPrompt parameter indicates the Text-to-Speech (TTS) prompt which is played to calls that are eligible for callback. This message should tell callers which DTMF touch-tone key (CallbackRequestDtmf) to press to select callback. This parameter, or `-CallbackOfferAudioFilePromptResourceId`, becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallbackEmailNotificationTarget + +The CallbackEmailNotificationTarget parameter must be set to a group ID (Microsoft 365, Distribution list, or Mail-enabled security) that will receive notification if a callback times out of the call queue or can't be completed for some other reason. This parameter becomes a required parameter when IsCallbackEnabled is set to `True`. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceLevelThresholdResponseTimeInSecond + +The target number of seconds calls should be answered in. This number is used to calculate the call queue service level percentage. + +A value of `$null` indicates that a service level percentage will not be calculated for this call queue. + +```yaml +Type: Int16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingForCallQueueTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The ComplianceRecordingForCallQueueTemplateId parameter indicates a list of up to 2 Compliance Recording for Call Queue templates to apply to the call queue. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCR parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCR +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCR parameter indicates the unique identifier for the Audio file prompt which is played to callers when compliance recording for call queues is enabled. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The TextAnnouncementForCRFailure parameter indicates the custom Text-to-Speech (TTS) prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomAudioFileAnnouncementForCRFailure +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The CustomAudioFileAnnouncementForCRFailure parameter indicates the unique identifier for the Audio file prompt which is played to callers if the compliance recording for call queue bot is unable to join or drops from the call. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedCallQueueHistoryTemplateId +_Voice applications private preview customers only._ + +_Saving a call queue configuration through Teams admin center will *remove* this setting._ + +The SharedCallQueueHistoryTemplateId parameter indicates the Shared Call Queue History template to apply to the call queue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShouldOverwriteCallableChannelProperty + +A Teams Channel can only be linked to one Call Queue at a time. To force reassignment of the Teams Channel to a new Call Queue, set this to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +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). + +## INPUTS + +## OUTPUTS + +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue + +## NOTES + +## RELATED LINKS +[Create a Phone System Call Queue](https://support.office.com/article/Create-a-Phone-System-call-queue-67ccda94-1210-43fb-a25b-7b9785f8a061) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Get-CsComplianceRecordingForCallQueueTemplate](./Get-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CsComplianceRecordingForCallQueueTemplate.md) + diff --git a/skype/skype-ps/skype/Set-CsCallingLineIdentity.md b/teams/teams-ps/teams/Set-CsCallingLineIdentity.md similarity index 64% rename from skype/skype-ps/skype/Set-CsCallingLineIdentity.md rename to teams/teams-ps/teams/Set-CsCallingLineIdentity.md index 5b846b9c8d..16e76a4a04 100644 --- a/skype/skype-ps/skype/Set-CsCallingLineIdentity.md +++ b/teams/teams-ps/teams/Set-CsCallingLineIdentity.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cscallinglineidentity -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cscallinglineidentity +applicable: Microsoft Teams title: Set-CsCallingLineIdentity schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -20,7 +20,7 @@ Use the `Set-CsCallingLineIdentity` cmdlet to modify a Caller ID policy in your ### Identity (Default) ``` Set-CsCallingLineIdentity [[-Identity] ] [-BlockIncomingPstnCallerID ] [-CallingIDSubstitute ] [-CompanyName ] -[-Description ] [-EnableUserOverride ] [-ResourceAccount ] [-ServiceNumber ] [-WhatIf] [-Confirm] [] +[-Description ] [-EnableUserOverride ] [-ResourceAccount ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -28,10 +28,8 @@ You can either change or block the Caller ID (also called a Calling Line ID) for By default, the Microsoft Teams or Skype for Business Online user's phone number can be seen when that user makes a call to a PSTN phone, or when a call comes in. You can modify a Caller ID policy to provide an alternate displayed number, or to block any number from being displayed. -Note: +Note: - Identity must be unique. -- ServiceNumber must be a valid Service Number in the tenant telephone number inventory. -- If CallerIdSubstitute is given as "Service", then ServiceNumber cannot be empty. - If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty. ## EXAMPLES @@ -42,45 +40,41 @@ PS C:\> Set-CsCallingLineIdentity -Identity "MyBlockingPolicy" -BlockIncomingPst ``` This example blocks the incoming caller ID. -The user can override this setting. ### Example 2 ``` -PS C:\> Set-CsCallingLineIdentity -Identity "UKOrgAA" -CallingIdSubstitute "Service" -ServiceNumber "14258828080" +PS C:\> Set-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true ``` -This example modifies the UKOrgAA Caller ID policy to sets the Caller ID to a specified service number. +This example modifies the new Anonymous Caller ID policy to block the incoming Caller ID. ### Example 3 ``` -PS C:\> Set-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true +$ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId +Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -ResourceAccount $ObjId -CompanyName "Contoso" ``` -This example modifies the new Anonymous Caller ID policy that blocks the incoming Caller ID. +This example modifies the Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso ### Example 4 ``` -$ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId -Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -ResourceAccount $ObjId -CompanyName "Contoso" +Set-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true ``` -This example modifies the Caller ID policy that sets the Caller ID to the phone number of the specified resource account and sets the Calling party name to Contoso - +This example modifies the Caller ID policy and allows Teams users to make anonymous calls. ## PARAMETERS ### -BlockIncomingPstnCallerID -The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. -The default value is false. +The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. -The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. -If this is set to True and if this policy is assigned to a Lync user, then Caller ID for incoming calls is suppressed/anonymous. +The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a Teams user, then Caller ID for incoming calls is suppressed/anonymous. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -91,13 +85,13 @@ Accept wildcard characters: False ### -CallingIDSubstitute The CallingIDSubstitute parameter lets you specify an alternate Caller ID. -The possible values are Anonymous, Service, LineUri and Resource. +The possible values are Anonymous, LineUri and Resource. ```yaml Type: CallingIDSubstituteType Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -113,7 +107,7 @@ This parameter sets the Calling party name (typically referred to as CNAM) on th Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -128,8 +122,8 @@ The Description parameter briefly describes the Caller ID policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -139,17 +133,21 @@ Accept wildcard characters: False ``` ### -EnableUserOverride -The EnableUserOverride switch lets the user override the Caller ID policy. +The EnableUserOverride parameter gives Microsoft Teams users the option under Settings and Calls to hide their phone number when making outgoing calls. The CallerID will be Anonymous. + +If CallingIDSubstitute is set to Anonymous, the EnableUserOverride parameter has no effect, and the caller ID is always set to Anonymous. + +EnableUserOverride has precedence over other settings in the policy unless substitution is set to Anonymous. For example, assume the policy instance has substitution using a resource account and EnableUserOverride is set and enabled by the user. In this case, the outbound caller ID will be blocked and Anonymous will be used. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -160,8 +158,8 @@ The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -171,32 +169,13 @@ Accept wildcard characters: False ``` ### -ResourceAccount -This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://docs.microsoft.com/microsoftteams/manage-resource-accounts. +This parameter specifies the ObjectId of a resource account/online application instance used for Teams Auto Attendant or Call Queue. The outgoing PSTN call will use the phone number defined on the resource account as caller id. For more information about resource accounts please see https://learn.microsoft.com/microsoftteams/manage-resource-accounts. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceNumber -The ServiceNumber parameter lets you add any valid service number for the CallingIdSubstitute. - -Note: Do not add '+' to the Service number. -For example, if the Service number is +1425-xxx-xxxx then valid input is 1425xxxxxxx. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -213,7 +192,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -229,7 +208,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -239,7 +218,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -248,10 +227,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +[Get-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/get-cscallinglineidentity) -[Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +[Grant-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/grant-cscallinglineidentity) -[New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +[New-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/new-cscallinglineidentity) -[Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +[Remove-CsCallingLineIdentity](https://learn.microsoft.com/powershell/module/teams/remove-cscallinglineidentity) diff --git a/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md b/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md new file mode 100644 index 0000000000..2ee33ba19c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsComplianceRecordingForCallQueueTemplate.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsComplianceRecordingForCallQueueTemplate +applicable: Microsoft Teams +title: Set-CsComplianceRecordingForCallQueueTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsComplianceRecordingForCallQueueTemplate + +## SYNTAX + +```powershell +Set-CsComplianceRecordingForCallQueueTemplate -Instance [] +``` + +## DESCRIPTION +Use the Set-CsComplianceRecordingForCallQueueTemplate cmdlet to make changes to an existing Compliance Recording for Call Queues template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$template = CsComplianceRecordingForCallQueueTemplate -Id 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01 +$template.BotId = 14732826-8206-42e3-b51e-6693e2abb698 +Set-CsComplianceRecordingForCallQueueTemplate $template +``` + +The Set-CsComplianceRecordingForCallQueueTemplate cmdlet lets you modify the properties of a Compliance Recording for Call Queue Template. + +## PARAMETERS + +### -Instance +The Instance parameter is the unique identifier assigned to the Compliance Recording for Call Queue template. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsComplianceRecordingForCallQueueTemplate](./New-CsComplianceRecordingForCallQueueTemplate.md) + +[Set-CsComplianceRecordingForCallQueueTemplate](./Set-CsComplianceRecordingForCallQueueTemplate.md) + +[Remove-CsComplianceRecordingForCallQueueTemplate](./Remove-CscomplianceRecordingForCallQueueTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQuuee](./Remove-CsCallQueue.md) + diff --git a/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md b/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md new file mode 100644 index 0000000000..4c738c2d83 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsExternalAccessPolicy.md @@ -0,0 +1,553 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy +applicable: Microsoft Teams +title: Set-CsExternalAccessPolicy +schema: 2.0.0 +ms.reviewer: rogupta +--- + +# Set-CsExternalAccessPolicy + +## SYNOPSIS +Enables you to modify the properties of an existing external access policy. +External access policies determine whether or not your users can: 1) communicate with users who have Session Initiation Protocol (SIP) accounts with a federated organization; 2) communicate with users who are using custom applications built with [Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop); 3) access Skype for Business Server over the Internet, without having to log on to your internal network; 4) communicate with users who have SIP accounts with a public instant messaging (IM) provider such as Skype; and, 5) communicate with people who are using Teams with an account that's not managed by an organization. + +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +### Identity (Default) +``` +Set-CsExternalAccessPolicy [[-Identity] ] + [-AllowedExternalDomains ] + [-BlockedExternalDomains ] + [-CommunicationWithExternalOrgs ] + [-Confirm] + [-Description ] + [-EnableAcsFederationAccess ] + [-EnableFederationAccess ] + [-EnableOutsideAccess ] + [-EnablePublicCloudAudioVideoAccess ] + [-EnableTeamsConsumerAccess ] + [-EnableTeamsConsumerInbound ] + [-EnableTeamsSmsAccess ] + [-EnableXmppAccess ] + [-FederatedBilateralChats ] + [-Force] + [-RestrictTeamsConsumerAccessToExternalUserProfiles ] + [-Tenant ] + [-WhatIf] + [] +``` + +### Instance +``` +Set-CsExternalAccessPolicy [-Instance ] + [-AllowedExternalDomains ] + [-BlockedExternalDomains ] + [-CommunicationWithExternalOrgs ] + [-Confirm] + [-Description ] + [-EnableAcsFederationAccess ] + [-EnableFederationAccess ] + [-EnableOutsideAccess ] + [-EnablePublicCloudAudioVideoAccess ] + [-EnableTeamsConsumerAccess ] + [-EnableTeamsConsumerInbound ] + [-EnableTeamsSmsAccess ] + [-EnableXmppAccess ] + [-FederatedBilateralChats ] + [-Force] + [-RestrictTeamsConsumerAccessToExternalUserProfiles ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION +When you install Skype for Business Server your users are only allowed to exchange instant messages and presence information among themselves: by default, they can only communicate with people who have SIP accounts in your Active Directory Domain Services. +In addition, users are not allowed to access Skype for Business Server over the Internet; instead, they must be logged on to your internal network before they will be able to log on to Skype for Business Server. + +That might be sufficient to meet your communication needs. +If it doesn't meet your needs, you can use external access policies to extend the ability of your users to communicate and collaborate. +External access policies can grant (or revoke) the ability of your users to do any or all of the following: + +1. Communicate with people who have SIP accounts with a federated organization. +Note that enabling federation alone will not provide users with this capability. +Instead, you must enable federation and then assign users an external access policy that gives them the right to communicate with federated users. + +2. (Microsoft Teams only) Communicate with users who are using custom applications built with [Azure Communication Services (ACS)](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). this policy setting only applies if acs federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet. + +3. Access Skype for Business Server over the Internet, without having to first log on to your internal network. +This enables your users to use Skype for Business and log on to Skype for Business Server from an Internet café or other remote location. + +4. Communicate with people who have SIP accounts with a public instant messaging service such as Skype. + + The following parameters are not applicable to Skype for Business Online/Microsoft Teams: Description, EnableXmppAccess, Force, Identity, Instance, PipelineVariable, and Tenant + +5. (Microsoft Teams Only) Communicate with people who are using Teams with an account that's not managed by an organization. This policy only applies if Teams Consumer Federation has been enabled at the tenant level using the [Set-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration) cmdlet or Teams admin center under the External Access setting. + +After an external access policy has been created, you can use the `Set-CsExternalAccessPolicy` cmdlet to change the property values of that policy. +For example, by default the global policy does not allow users to communicate with people who have accounts with a federated organization. +If you would like to grant this capability to all of your users you can call the `Set-CsExternalAccessPolicy` cmdlet and set the value of the global policy's EnableFederationAccess property to True. + +## EXAMPLES + +### -------------------------- Example 1 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True +``` + +The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. +In this example, the command changes the value of the EnableFederationAccess property to True. + +### -------------------------- Example 2 ------------------------ +``` +Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True +``` + +In Example 2, federation access is enabled for all the external access policies configured for use in the organization. +To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. +That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. + +### -------------------------- Example 3 ------------------------ +``` +Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True +``` + +Example 3 enables federation access for all the external access policies that have been configured at the per-user scope. +To carry out this task, the first thing the command does is use the `Get-CsExternalAcessPolicy` cmdlet and the Filter parameter to return a collection of all the policies that have been configured at the per-user scope. +(The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". +Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. + +### -------------------------- Example 4 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false +New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true +``` + +In this example, the Global policy is updated to disallow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation enabled and which can be assigned to selected users for which Team-ACS federation will be allowed. + +### -------------------------- Example 5 ------------------------ +``` +Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true +New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false +``` + +In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. + +### -------------------------- Example 6 ------------------------ +``` +New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com") +Set-CsTenantFederationConfiguration -CustomizeFederation $true +``` +In this example, we create an ExternalAccessPolicy named "GranularFederationExample" that allows communication with specific external domains, namely `example1.com` and `example2.com`. The federation policy is set to restrict communication to only these allowed domains. + +## PARAMETERS + +### -Identity +Unique identifier for the external access policy to be modified. +External access policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +If this parameter is not specified then the global policy will be modified. + +Note that wildcards are not allowed when specifying an Identity. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AllowedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains allowed to communicate with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `AllowSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedExternalDomains +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Specifies the external domains blocked from communicating with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `BlockSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed. +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommunicationWithExternalOrgs +> [!NOTE] +> Please note that this parameter is in Private Preview. + +Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options: + +- OrganizationDefault: users follow the federation settings specified in `TenantFederationConfiguration`. This is the default value. +- AllowAllExternalDomains: users are allowed to communicate with all domains. +- AllowSpecificExternalDomains: users can communicate with external domains listed in `AllowedExternalDomains`. +- BlockSpecificExternalDomains: users are blocked from communicating with domains listed in `BlockedExternalDomains`. +- BlockAllExternalDomains: users cannot communicate with any external domains. + +The setting is only applicable when `EnableFederationAccess` is set to true. This setting can only be modified in custom policies. In the Global (default) policy, it is fixed to `OrganizationDefault` and cannot be changed. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: OrganizationDefault +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide additional text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAcsFederationAccess +Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. + +Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableFederationAccess +Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOutsideAccess +Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePublicCloudAudioVideoAccess +Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. +When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerAccess +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsConsumerInbound +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](https://learn.microsoft.com/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableTeamsSmsAccess +Allows you to control whether users can have SMS text messaging capabilities within Teams. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableXmppAccess +Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FederatedBilateralChats +> [!NOTE] +> Please note that this parameter is in Private Preview. + +This setting enables bi-lateral chats for the users included in the messaging policy. + +Some organizations may want to restrict who users are able to message in Teams. While organizations have always been able to limit users' chats to only other internal users, organizations can now limit users' chat ability to only chat with other internal users and users in one other organization via the bilateral chat policy. + +Once external access and bilateral policy is set up, users with the policy can be in external group chats only with a maximum of two organizations. When they try to create a new external chat with users from more than two tenants or add a user from a third tenant to an existing external chat, a system message will be shown preventing this action. + +Users with bilateral policy applied are also removed from existing external group chats with more than two organizations. + +This policy doesn't apply to meetings, meeting chats, or channels. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictTeamsConsumerAccessToExternalUserProfiles +Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business 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/?LinkID=113216). + +## INPUTS + +### Input types +Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +The `Set-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. + +## OUTPUTS + +### Output types +The `Set-CsExternalAccessPolicy` cmdlet does not return a value or object. +Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. + +## NOTES + +## RELATED LINKS + +[Get-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/get-csexternalaccesspolicy) + +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) + +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) + +[Remove-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md index 76a290f694..c74a4f85ba 100644 --- a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment +online version: https://learn.microsoft.com/powershell/module/teams/set-csgrouppolicyassignment +title: Set-CsGroupPolicyAssignment schema: 2.0.0 author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsGroupPolicyAssignment @@ -15,11 +16,10 @@ ms.reviewer: > [!NOTE] > The cmdlet Set-CsGroupPolicyAssignment is not yet available. In the meantime, to change a group policy assignment you can first remove the current policy assignment from the group and then add a new policy assignment. - ## RELATED LINKS -[New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +[New-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/new-csgrouppolicyassignment) -[Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) -[Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +[Remove-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csgrouppolicyassignment) diff --git a/skype/skype-ps/skype/Set-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md similarity index 79% rename from skype/skype-ps/skype/Set-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md index 10f26b7910..010cb41526 100644 --- a/skype/skype-ps/skype/Set-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/teams/Set-CsInboundBlockedNumberPattern.md @@ -1,146 +1,146 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csinboundblockednumberpattern -applicable: Microsoft Teams, Skype for Business Online -title: Set-CsInboundBlockedNumberPattern -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: bulenteg -schema: 2.0.0 ---- - -# Set-CsInboundBlockedNumberPattern - -## SYNOPSIS -Modifies one or more parameters of a blocked number pattern in the tenant list. - -## SYNTAX - -### Identity (Default) -``` -Set-CsInboundBlockedNumberPattern [[-Identity] ] [-Description ] [-Enabled ] [-Pattern ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet modifies one or more parameters of a blocked number pattern in the tenant list. - -## EXAMPLES - -### Example 1 -```powershell -PS> Set-CsInboundBlockedNumberPattern -Identity "BlockAutomatic" -Pattern "^\+11234567890" -``` - -This example modifies a blocked number pattern to block inbound calls from +11234567890 number. - -## PARAMETERS - -### -Description -A friendly description for the blocked number pattern to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -If this parameter is set to True, the inbound calls matching the pattern will be blocked. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -A unique identifier specifying the blocked number pattern to be modified. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern -A regular expression that the calling number must match in order to be blocked. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -[New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) - -[Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) - -[Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Set-CsInboundBlockedNumberPattern +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: bulenteg +schema: 2.0.0 +--- + +# Set-CsInboundBlockedNumberPattern + +## SYNOPSIS +Modifies one or more parameters of a blocked number pattern in the tenant list. + +## SYNTAX + +### Identity (Default) +``` +Set-CsInboundBlockedNumberPattern [[-Identity] ] [-Description ] [-Enabled ] [-Pattern ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet modifies one or more parameters of a blocked number pattern in the tenant list. + +## EXAMPLES + +### Example 1 +```powershell +PS> Set-CsInboundBlockedNumberPattern -Identity "BlockAutomatic" -Pattern "^\+11234567890" +``` + +This example modifies a blocked number pattern to block inbound calls from +11234567890 number. + +## PARAMETERS + +### -Description +A friendly description for the blocked number pattern to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +If this parameter is set to True, the inbound calls matching the pattern will be blocked. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +A unique identifier specifying the blocked number pattern to be modified. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that the calling number must match in order to be blocked. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[New-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundblockednumberpattern) + +[Get-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundblockednumberpattern) + +[Remove-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundblockednumberpattern) diff --git a/skype/skype-ps/skype/Set-CsInboundExemptNumberPattern.md b/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md similarity index 70% rename from skype/skype-ps/skype/Set-CsInboundExemptNumberPattern.md rename to teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md index 030b83a306..592cc10d0f 100644 --- a/skype/skype-ps/skype/Set-CsInboundExemptNumberPattern.md +++ b/teams/teams-ps/teams/Set-CsInboundExemptNumberPattern.md @@ -1,166 +1,167 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csinboundexemptnumberpattern -applicable: Microsoft Teams, Skype for Business Online -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Set-CsInboundExemptNumberPattern - -## SYNOPSIS - -Modifies one or more parameters of an exempt number pattern in the tenant list. - -## SYNTAX - -### Identity (Default) -``` -Set-CsInboundExemptNumberPattern [[-Identity] ] [-Description ] [-Enabled ] [-Pattern ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -This cmdlet modifies one or more parameters of a exempt number pattern in the tenant list. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -PS> Set-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Pattern "^\+?1312555888[2|3]$" -``` - -Sets the inbound exempt number pattern for AllowContoso1 - -### EXAMPLE 2 - -```powershell -PS> Set-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Enabled $False -``` - -Disables the exempt number pattern from usage in call blocking - -## PARAMETERS - -### -Description - -Sets the description of the number pattern. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -This parameter determines whether the number pattern is enabled for exemption or not. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier for the exempt number pattern to be changed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern - -A regular expression that the calling number must match in order to be exempt from blocking. It is best pratice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. - -```yaml -Type: System.String -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 -``` - -### -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 -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -You can use Test-CsInboundBlockedNumberPattern to test your block and exempt phone number ranges. - -## RELATED LINKS - -[Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) - -[New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) - -[Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) - -[Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) - -[Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csinboundexemptnumberpattern +applicable: Microsoft Teams +title: Set-CsInboundExemptNumberPattern +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Set-CsInboundExemptNumberPattern + +## SYNOPSIS + +Modifies one or more parameters of an exempt number pattern in the tenant list. + +## SYNTAX + +### Identity (Default) +``` +Set-CsInboundExemptNumberPattern [[-Identity] ] [-Description ] [-Enabled ] [-Pattern ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This cmdlet modifies one or more parameters of an exempt number pattern in the tenant list. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS> Set-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Pattern "^\+?1312555888[2|3]$" +``` + +Sets the inbound exempt number pattern for AllowContoso1 + +### EXAMPLE 2 + +```powershell +PS> Set-CsInboundExemptNumberPattern -Identity "AllowContoso1" -Enabled $False +``` + +Disables the exempt number pattern from usage in call blocking + +## PARAMETERS + +### -Description + +Sets the description of the number pattern. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter determines whether the number pattern is enabled for exemption or not. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier for the exempt number pattern to be changed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern + +A regular expression that the calling number must match in order to be exempt from blocking. It is best practice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. + +```yaml +Type: System.String +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 +``` + +### -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 +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +You can use Test-CsInboundBlockedNumberPattern to test your block and exempt phone number ranges. + +## RELATED LINKS + +[Get-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/get-csinboundexemptnumberpattern) + +[New-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/new-csinboundexemptnumberpattern) + +[Remove-CsInboundExemptNumberPattern](https://learn.microsoft.com/powershell/module/teams/remove-csinboundexemptnumberpattern) + +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) + +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) diff --git a/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..4e64fee3fa --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md @@ -0,0 +1,187 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance +applicable: Microsoft Teams +title: Set-CsOnlineApplicationInstance +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsOnlineApplicationInstance + +## SYNOPSIS +Updates an application instance in Microsoft Entra ID. + +**Note**: The use of this cmdlet for assigning phone numbers in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + +## SYNTAX + +``` +Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] ] [[-ApplicationId] ] [[-AcsResourceId] ] [[-DisplayName] ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet is used to update an application instance in Microsoft Entra ID. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Set-CsOnlineApplicationInstance -Identity appinstance01@contoso.com -ApplicationId ce933385-9390-45d1-9512-c8d228074e07 -DisplayName "AppInstance01" +``` + +This example shows updated ApplicationId and DisplayName information for an existing Auto Attendant application instance with Identity "appinstance01@contoso.com". + +## PARAMETERS + +### -Identity +The URI or ID of the application instance to update. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnpremPhoneNumber +**Note**: Using this parameter has been deprecated in commercial and GCC cloud instances. Use the new Set-CsPhoneNumberAssignment cmdlet instead. + +Assigns a hybrid (on-premise) telephone number to the application instance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The display name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Sync-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance) diff --git a/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md new file mode 100644 index 0000000000..a1b9ec1f59 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsOnlineAudioConferencingRoutingPolicy.md @@ -0,0 +1,177 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineaudioconferencingroutingpolicy +title: Set-CsOnlineAudioConferencingRoutingPolicy +schema: 2.0.0 +--- + +# Set-CsOnlineAudioConferencingRoutingPolicy + +## SYNOPSIS + +This cmdlet sets the Online Audio Conferencing Routing Policy for users in the tenant. + +## SYNTAX + +```powershell +Set-CsOnlineAudioConferencingRoutingPolicy [-Description ] [[-Identity] ] + [-OnlinePstnUsages ] [-RouteType ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Teams meeting dial-out calls are initiated from within a meeting in your organization to PSTN numbers, including call-me-at calls and calls to bring new participants to a meeting. + +To enable Teams meeting dial-out routing through Direct Routing to on-network users, you need to create and assign an Audio Conferencing routing policy called "OnlineAudioConferencingRoutingPolicy." + +The OnlineAudioConferencingRoutingPolicy policy is equivalent to the CsOnlineVoiceRoutingPolicy for 1:1 PSTN calls via Direct Routing. + +Audio Conferencing voice routing policies determine the available routes for calls from meeting dial-out based on the destination number. Audio Conferencing voice routing policies link to PSTN usages, determining routes for meeting dial-out calls by associated organizers. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsOnlineAudioConferencingRoutingPolicy -Identity "Policy 1" -OnlinePstnUsages "US and Canada" +``` + +Sets the Online Audio Conferencing Routing Policy "Policy 1" value of "OnlinePstnUsages" to "US and Canada". + +## 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 +``` + +### -Description + +Enables administrators to provide explanatory text about the Online Audio Conferencing Routing policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Online Audio Conferencing Routing Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlinePstnUsages + +A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online audio conferencing routing policy. The online PSTN usages must be existing usages (PSTN usages can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet). + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteType + +For internal use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +[New-CsOnlineAudioConferencingRoutingPolicy](New-CsOnlineAudioConferencingRoutingPolicy.md) +[Remove-CsOnlineAudioConferencingRoutingPolicy](Remove-CsOnlineAudioConferencingRoutingPolicy.md) +[Grant-CsOnlineAudioConferencingRoutingPolicy](Grant-CsOnlineAudioConferencingRoutingPolicy.md) +[Get-CsOnlineAudioConferencingRoutingPolicy](Get-CsOnlineAudioConferencingRoutingPolicy.md) diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingBridge.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md similarity index 86% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md index ea4654d32f..a0d2c3d32d 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingBridge.md +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingBridge.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinedialinconferencingbridge -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingbridge +applicable: Microsoft Teams title: Set-CsOnlineDialInConferencingBridge schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsOnlineDialInConferencingBridge @@ -50,7 +50,6 @@ Set-CsOnlineDialInConferencingBridge -Name "Conference Bridge" -DefaultServiceNu This example sets the default dial-in phone number to 14255551234 for the audio conferencing bridge named "Conference Bridge". - ### -------------------------- Example 2 -------------------------- ``` $bridge = Get-CsOnlineDialInConferencingBridge -Name "Conference Bridge" @@ -60,8 +59,7 @@ $Bridge.Name = "O365 Bridge" Set-CsOnlineDialInConferencingBridge -Instance $bridge ``` -This example changes the name of a conference bridge by creating an conference bridge instance, changing the instance's name and then setting the conference bridge to the instance. - +This example changes the name of a conference bridge by creating a conference bridge instance, changing the instance's name and then setting the conference bridge to the instance. ## PARAMETERS @@ -71,8 +69,8 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -87,8 +85,8 @@ Allows you to pass a reference to a Microsoft audio conferencing bridge object t ```yaml Type: ConferencingBridge Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -103,8 +101,8 @@ Specifies the name of the audio conferencing bridge to be modified. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -120,7 +118,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -139,8 +137,8 @@ Also, when the default service number is changed, the service number of existing ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -161,7 +159,7 @@ Computer name: -DomainController atl-cs-001 Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -178,8 +176,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -194,8 +192,8 @@ PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -210,8 +208,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -226,8 +224,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -244,7 +242,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -254,7 +252,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -263,4 +261,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md similarity index 89% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md index 95068004d7..a64dcc2c2b 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinedialinconferencingservicenumber -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams title: Set-CsOnlineDialInConferencingServiceNumber schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsOnlineDialInConferencingServiceNumber @@ -94,7 +94,6 @@ Set-CsOnlineDialInConferencingServiceNumber -Identity +14255551234 -PrimaryLangu This example sets the primary language to German (Germany) and the secondary languages to US English, Japanese, and UK English for the dial-in service number +14255551234. - ## PARAMETERS ### -Identity @@ -104,8 +103,8 @@ The service number can be specified in the following formats: E.164 number, +\] [-EnableEntryExitNotifications ] - [-EntryExitAnnouncementsType ] [-EnableNameRecording ] - [-IncludeTollFreeNumberInMeetingInvites ] [-PinLength ] - [-AllowPSTNOnlyMeetingsByDefault ] [-AutomaticallySendEmailsToUsers ] - [-SendEmailFromOverride ] [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] - [-AutomaticallyReplaceAcpProvider ] [-UseUniqueConferenceIds ] - [-AutomaticallyMigrateUserMeetings ] [-MigrateServiceNumbersOnCrossForestMove ] - [-EnableDialOutJoinConfirmation ] [[-Identity] ] [-MaskPstnNumbersType ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### Instance -``` -Set-CsOnlineDialInConferencingTenantSettings [-Tenant ] [-EnableEntryExitNotifications ] - [-EntryExitAnnouncementsType ] [-EnableNameRecording ] - [-IncludeTollFreeNumberInMeetingInvites ] [-PinLength ] - [-AllowPSTNOnlyMeetingsByDefault ] [-AutomaticallySendEmailsToUsers ] - [-SendEmailFromOverride ] [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] - [-AutomaticallyReplaceAcpProvider ] [-UseUniqueConferenceIds ] - [-AutomaticallyMigrateUserMeetings ] [-MigrateServiceNumbersOnCrossForestMove ] - [-EnableDialOutJoinConfirmation ] [-Instance ] [-MaskPstnNumbersType ] [-Force] [-WhatIf] [-Confirm] - [] +```powershell +Set-CsOnlineDialInConferencingTenantSettings [-AllowedDialOutExternalDomains ] + [-AllowFederatedUsersToDialOutToSelf ] [-AllowFederatedUsersToDialOutToThirdParty ] + [-AllowPSTNOnlyMeetingsByDefault ] [-AutomaticallyMigrateUserMeetings ] + [-AutomaticallyReplaceAcpProvider ] [-AutomaticallySendEmailsToUsers ] + [-EnableDialOutJoinConfirmation ] [-EnableEntryExitNotifications ] + [-EnableNameRecording ] [-EntryExitAnnouncementsType ] [[-Identity] ] + [-IncludeTollFreeNumberInMeetingInvites ] [-MaskPstnNumbersType ] + [-MigrateServiceNumbersOnCrossForestMove ] [-PinLength ] [-SendEmailFromAddress ] + [-SendEmailFromDisplayName ] [-SendEmailFromOverride ] [-UseUniqueConferenceIds ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -54,7 +37,7 @@ For more information, see `Get-CsOnlineDialinConferencingTenantConfiguration`. There is always a single instance of the dial-in conferencing settings per tenant. You can modify the settings using `Set-CsOnlineDialInConferencingTenantSettings` and revert those settings to their defaults by using `Remove-CsOnlineDialInConferencingTenantSettings`. -The following parameters are not applicable to Skype for Business Online: EnableDialOutJoinConfirmation, IncludeTollFreeNumberInMeetingInvites, MigrateServiceNumbersOnCrossForestMove, and UseUniqueConferenceIds +The following parameters are not applicable to Teams: EnableDialOutJoinConfirmation, IncludeTollFreeNumberInMeetingInvites, MigrateServiceNumbersOnCrossForestMove, and UseUniqueConferenceIds ## EXAMPLES @@ -66,7 +49,6 @@ Set-CsOnlineDialInConferencingTenantSettings -EnableEntryExitNotifications $True This example sets the tenant's conferencing settings to enable entry and exit notifications supported by name recording. The PIN length is set to 7. - ### -------------------------- Example 2 -------------------------- ``` Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendEmailFromAddress admin@contoso.com -SendEmailFromDisplayName "Conferencing Administrator" @@ -74,9 +56,58 @@ Set-CsOnlineDialInConferencingTenantSettings -SendEmailFromOverride $true -SendE This example defines the contact information to be used in dial-in conferencing email notifications and enables the default address to be overridden. - ## PARAMETERS +### -AllowedDialOutExternalDomains + +Used to specify which external domains are allowed for dial-out conferencing. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedUsersToDialOutToSelf + +Meeting participants can call themselves when they join a meeting. Possible settings are [No|Yes|RequireSameEnterpriseUser]. + This parameter is Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFederatedUsersToDialOutToThirdParty + +Specifies at this scope if dial out to third party participants is allowed. Possible settings are [No|Yes|RequireSameEnterpriseUser]. +This parameter is Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowPSTNOnlyMeetingsByDefault Specifies the default value that gets assigned to the "AllowPSTNOnlyMeetings" setting of users when they are enabled for dial-in conferencing, or when a user's dial-in conferencing provider is set to Microsoft. If set to $true, the "AllowPSTNOnlyMeetings" setting of the user will also be set to true. @@ -94,8 +125,8 @@ For more information on the "AllowPSTNOnlyMeetings" user setting, see `Set-CsOnl ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -105,13 +136,15 @@ Accept wildcard characters: False ``` ### -AutomaticallyMigrateUserMeetings + +Specifies if meetings of users in the tenant should automatically be rescheduled via the Meeting Migration Service when there's a change in the users' Cloud PSTN Confernecing coordinates, e.g. when a user is provisioned, de-provisoned, assigned a new default service number etc. If this is false, users will need to manually migrate their conferences using the Meeting Migration tool. PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -121,13 +154,15 @@ Accept wildcard characters: False ``` ### -AutomaticallyReplaceAcpProvider + +Specifies if a user already enabled for a 3rd party Audio Conferencing Provider (ACP) should automatically be converted to Microsoft's Online DialIn Conferencing service when a license for Microsoft's service is assigned to the user. If this is false, tenant admins will need to manually provision the user with the Enable-CsOnlineDialInConferencingUser cmdlet with the -ReplaceProvider switch present. PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -152,8 +187,8 @@ Changes to either the user's conference ID, or the user's default dial-in confer ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -169,7 +204,23 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableDialOutJoinConfirmation + +Specifies if the callees need to confirm to join the conference call. If true, the callees will hear prompts to ask for confirmation to join the conference call, otherwise callees will join the conference call directly. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -179,6 +230,7 @@ Accept wildcard characters: False ``` ### -EnableEntryExitNotifications + Specifies if, by default, announcements are made as users enter and exit a conference call. Set to $true to enable notifications, $false to disable notifications. The default is $true. @@ -188,8 +240,8 @@ This setting can be overridden on a meeting by meeting basis when a user joins a ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -199,6 +251,7 @@ Accept wildcard characters: False ``` ### -EnableNameRecording + Specifies whether the name of a user is recorded on entry to the conference. This recording is used during entry and exit notifications. Set to $true to enable name recording, set to $false to bypass name recording. @@ -207,8 +260,8 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -218,13 +271,15 @@ Accept wildcard characters: False ``` ### -EntryExitAnnouncementsType + +Specifies if the Entry and Exit Announcement Uses names or tones only. PARAMVALUE: UseNames | ToneOnly ```yaml Type: EntryExitAnnouncementsType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -241,8 +296,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -257,8 +312,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -273,8 +328,8 @@ This parameter is obsolete and not functional. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -289,8 +344,8 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -300,13 +355,31 @@ Accept wildcard characters: False ``` ### -MigrateServiceNumbersOnCrossForestMove + +Specifies whether service numbers assigned to the tenant should be migrated to the new forest of the tenant when the tenant is migrated cross region. If false, service numbers will be released back to stock once the migration completes. This settings does not apply to ported-in numbers that are always migrated. PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Microsoft internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -326,8 +399,8 @@ The PIN of a user that did not schedule the meeting will not enable that user to ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -348,8 +421,8 @@ Note: The parameter has been deprecated and may be removed in future versions. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -368,8 +441,8 @@ Note: The parameter has been deprecated and may be removed in future versions. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -393,8 +466,8 @@ Note: The parameter has been deprecated and may be removed in future versions. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -409,8 +482,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -420,13 +493,15 @@ Accept wildcard characters: False ``` ### -UseUniqueConferenceIds + +Specifies if Private Meetings are enabled for the users in this tenant. PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -463,7 +538,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -473,19 +548,15 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None - ## OUTPUTS -### -None. - ## NOTES ## RELATED LINKS +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) +[Remove-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/remove-csonlinedialinconferencingtenantsettings) diff --git a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md similarity index 72% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md index 2bce296051..a0768687dc 100644 --- a/skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md +++ b/teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md @@ -1,13 +1,9 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguser -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinedialinconferencinguser +applicable: Microsoft Teams title: Set-CsOnlineDialInConferencingUser schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Set-CsOnlineDialInConferencingUser @@ -15,7 +11,7 @@ ms.reviewer: ## SYNOPSIS > [!NOTE] -> The AllowPSTNOnlyMeetings, ResetConferenceId, and ConferenceId parameters will be deprecated on Jan 31, 2022. To allow Teams meeting participants joining via the PSTN to bypass the lobby, use the AllowPSTNUsersToBypassLobby of the [Set-CsTeamsMeetingPolicy cmdlet](https://docs.microsoft.com/powershell/module/skype/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. +> The AllowPSTNOnlyMeetings, ResetConferenceId, and ConferenceId parameters will be deprecated on Jan 31, 2022. To allow Teams meeting participants joining via the PSTN to bypass the lobby, use the AllowPSTNUsersToBypassLobby of the [Set-CsTeamsMeetingPolicy cmdlet](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy). The capabilities associated with the ResetConferenceId and ConferenceId parameters are no longer supported. Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of a user that has been enabled for Microsoft's audio conferencing service. @@ -24,20 +20,18 @@ Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of ### TenantIdParams (Default) ``` Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId ] - [-BridgeName ] [-Tenant ] [-ConferenceId ] [-ResetConferenceId] - [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] + [-BridgeName ] [-Tenant ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] - [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] + [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] [-AsJob] [-WhatIf] [-Confirm] [] ``` ### TenantDomainParams ``` Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId ] - [-BridgeName ] -TenantDomain [-ConferenceId ] [-ResetConferenceId] - [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] + [-BridgeName ] [-TenantDomain ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] - [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] + [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -50,19 +44,17 @@ The cmdlet will verify that the correct license is assigned to the user. ### -------------------------- Example 1 -------------------------- ``` -Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ConferenceId 3542699 -ResetLeaderPin -ServiceNumber 14255037265 +Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ResetLeaderPin -ServiceNumber 14255037265 ``` -This example shows how to set a ConferenceId for a user, reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. - +This example shows how to reset the meeting leader's PIN and set the audio conferencing provider default meeting phone number. ### -------------------------- Example 2 -------------------------- ``` -Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" -ConferenceId 3542699 +Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conference Bridge" ``` -This example sets a user's ConferenceId and conference bridge assignment. - +This example sets a user's conference bridge assignment. ## PARAMETERS @@ -74,8 +66,8 @@ You can also reference a user account by using the user's Active Directory disti ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -92,8 +84,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -111,8 +103,8 @@ The default is false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -127,8 +119,8 @@ Specifies the globally-unique identifier (GUID) for the audio conferencing bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -143,33 +135,8 @@ Specifies the name of the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConferenceId -Specifies the ConferenceId that will be used by the user for dial-in meetings. -The cmdlet will fail if: - -The ConferenceId is already being used in the bridge where the user is assigned, or to which the user would be assigned. - -The ConferenceId doesn't meet the ConferenceId format requirements. - -ConferenceId and ResetConferenceId are mutually exclusive. -When ConferenceId is specified the new ConferenceId will be assigned to the user. -When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: Passcode -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -185,7 +152,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -208,7 +175,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -225,30 +192,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetConferenceId -Specifies whether to reset the ConferenceId for meetings that the user is organizing. -If specified, the meetings using the old ConferenceId will fail. -The user will have to reschedule his existing meetings, or run the meeting migration tool. - -ConferenceId and ResetConferenceId are mutually exclusive. -When ConferenceId is specified the new ConferenceId will be assigned to the user. -When ResetConferenceId is specified, the user will get an auto-generated ConferenceId. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ResetPasscode -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -263,8 +208,8 @@ Specifies whether to reset the meeting organizer or leaders PIN for meetings. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -279,8 +224,8 @@ Send an email to the user containing their Audio Conference information. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -295,8 +240,8 @@ You can specify the From Address to send the email that contains the Audio Confe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -311,8 +256,8 @@ You can specify the Display Name to send the email that contains the Audio Confe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -327,8 +272,8 @@ You can specify the To Address to send the email that contains the Audio Confere ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -347,8 +292,8 @@ The service number can be specified in the following formats: E.164 number, +\ [!IMPORTANT] +>This command is being deprecated and will not be available after July 7, 2024. If you are using this command to bulk update Audio conferencing Toll or Toll free phone numbers for users in your organization you can do that using the following alternative methods. +> 1. Use a custom Teams audio conferencing policy - [Audio Conferencing toll-free number policies - Microsoft Teams | Microsoft Learn](https://learn.microsoft.com/en-us/microsoftteams/audio-conferencing-toll-free-numbers-policy) +> 2. Use Set-CsOnlineDialinConferencingUser - [Set-CsOnlineDialInConferencingUser (MicrosoftTeamsPowerShell) | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/module/teams/set-csonlinedialinconferencinguser?view=teams-ps) +> +>If you need assistance in using any of the above methods to achieve what you previously did with the Set-CsOnlineDialInConferencingUserDefaultNumber command, please open a support case with our customer support team. + ## SYNTAX ### BridgeNameParams @@ -52,17 +59,16 @@ Set-CsOnlineDialInConferencingUserDefaultNumber -FromNumber 14255550100 -ToNumbe This example replaces the default toll or toll-free number for all users who have the number 14255550100 as a default number to the number 14255550101 and starts the process of rescheduling their meetings. - ## PARAMETERS ### -BridgeId -The Bridge Id results from running [Get-CsOnlineDialInConferencingBridge](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) +The Bridge Id results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) For example "9884626f-dcfb-49f4-8025-912f5bc68fdc". You can either specify BridgeName or BridgeId. ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -73,13 +79,13 @@ Accept wildcard characters: False ``` ### -BridgeName -The Bridge Name results from running [Get-CsOnlineDialInConferencingBridge](https://docs.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) +The Bridge Name results from running [Get-CsOnlineDialInConferencingBridge](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge) For example "Conference Bridge". You can either specify BridgeName or BridgeId. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -95,7 +101,7 @@ A String representing the Country or Region this Dial In Conferencing Default nu ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -112,7 +118,7 @@ $null if no number defined. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -132,7 +138,7 @@ Valid values are ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -148,7 +154,7 @@ The new number to assign, without the + sign, for example 14255550101. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -164,7 +170,7 @@ A String representing the Area or State this Dial In Conferencing Default number ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -180,7 +186,7 @@ A String representing the Capital or Major City this Dial In Conferencing Defaul ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -228,7 +234,7 @@ The Force switch specifies whether to suppress warning and confirmation messages ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -239,12 +245,12 @@ Accept wildcard characters: False ``` ### -RescheduleMeetings -Sends e-mail notifications to Meeting attendes with the updated settings. +Sends e-mail notifications to Meeting attendees with the updated settings. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -260,7 +266,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -276,7 +282,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -303,7 +309,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -312,4 +318,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md b/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md similarity index 75% rename from skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md index e83571e510..289ee4575e 100644 --- a/skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md @@ -1,26 +1,26 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlineenhancedemergencyservicedisclaimer -applicable: Skype for Business Online, Microsoft Teams +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineenhancedemergencyservicedisclaimer +applicable: Microsoft Teams title: Set-CsOnlineEnhancedEmergencyServiceDisclaimer schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsOnlineEnhancedEmergencyServiceDisclaimer ## SYNOPSIS When using Microsoft Teams PSTN Calling Services you need to record your organization's acceptance of the enhanced emergency service terms and conditions. This is done per -country and it needs to be done before you can provide PSTN calling services to Microsoft Teams users in the country. +country/region and it needs to be done before you can provide PSTN calling services to Microsoft Teams users in the country/region. -You can record your organization's acceptance using the Set-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet at any time. If you haven't accepted it for a given country +You can record your organization's acceptance using the Set-CsOnlineEnhancedEmergencyServiceDisclaimer cmdlet at any time. If you haven't accepted it for a given country/region you will be prompted to do so by warning information in the Teams PS Module, when you try to assign a phone number to a Microsoft Teams user, or in the Teams admin center, -when you create an emergency address in a country. +when you create an emergency address in a country/region. -Any tenant administrator can accept the terms and conditions and it only needs to be done once per country. +Any tenant administrator can accept the terms and conditions and it only needs to be done once per country/region. As the output the cmdlet will show the emergency service disclaimer and that it has been accepted. You can use Get-CsOnlineEnhancedEmergencyServiceDisclaimer to see the status of the emergency service disclaimer. @@ -34,8 +34,7 @@ Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion [-Versi ## DESCRIPTION You must run this cmdlet prior to assigning Microsoft Calling Plan phone numbers and locations to voice enabled users or accept the similar disclaimer in the Teams admin center. -Microsoft Calling Plan phone numbers are available in several countries, see [Country and region availability for Audio Conferencing and Calling Plans](https://docs.microsoft.com/MicrosoftTeams/country-and-region-availability-for-audio-conferencing-and-calling-plans/country-and-region-availability-for-audio-conferencing-and-calling-plans) - +Microsoft Calling Plan phone numbers are available in several countries/regions, see [Country and region availability for Audio Conferencing and Calling Plans](https://learn.microsoft.com/MicrosoftTeams/country-and-region-availability-for-audio-conferencing-and-calling-plans/country-and-region-availability-for-audio-conferencing-and-calling-plans) ## EXAMPLES @@ -47,7 +46,6 @@ Set-CsOnlineEnhancedEmergencyServiceDisclaimer -CountryOrRegion US This example accepts the U.S. version of the enhanced emergency service terms and conditions. - ## PARAMETERS ### -CountryOrRegion @@ -56,8 +54,7 @@ Specifies the region or country whose terms and conditions you wish to accept. Y ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: False Position: Named @@ -73,7 +70,6 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online, Microsoft Teams Required: False Position: Named @@ -89,7 +85,6 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online, Microsoft Teams Required: False Position: Named @@ -106,8 +101,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: False Position: Named @@ -122,8 +116,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: False Position: Named @@ -138,8 +131,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: False Position: Named @@ -154,8 +146,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Microsoft Teams +Aliases: Required: False Position: Named @@ -172,7 +163,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online, Microsoft Teams Required: False Position: Named @@ -182,19 +172,13 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None - ## OUTPUTS -### -None - ## NOTES ## RELATED LINKS -[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +[Get-CsOnlineEnhancedEmergencyServiceDisclaimer](https://learn.microsoft.com/powershell/module/teams/get-csonlineenhancedemergencyservicedisclaimer) diff --git a/skype/skype-ps/skype/Set-CsOnlineLisCivicAddress.md b/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md similarity index 67% rename from skype/skype-ps/skype/Set-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md index 80c1b48214..49f8ab38fe 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/teams/Set-CsOnlineLisCivicAddress.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlineliscivicaddress -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliscivicaddress +applicable: Microsoft Teams title: Set-CsOnlineLisCivicAddress schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -16,6 +16,12 @@ ms.reviewer: Use the \`Set-CsOnlineLisCivicAddress\` cmdlet to modify an existing civic address which has not been validated. Validated civic addresses cannot be modified. +> [!IMPORTANT] +> Due to a current issue, the parameters **-CompanyName** and **-CountryOrRegion** are required as an interim workaround for this cmdlet. + +> [!Note] +> This cmdlet is only available for public use with limited countries and certain fields. The remaining countries and fields are for Microsoft internal use only. + ## SYNTAX ``` @@ -24,25 +30,30 @@ Set-CsOnlineLisCivicAddress -CivicAddressId [-CompanyName ] [-Com [-PreDirectional ] [-PostDirectional ] [-City ] [-CityAlias ] [-StateOrProvince ] [-CountryOrRegion ] [-PostalCode ] [-Description ] [-ValidationStatus ] [-Latitude ] [-Longitude ] [-Confidence ] - [-Elin ] [-Force] [-WhatIf] [-Confirm] + [-Elin ] [-IsAzureMapValidationRequired ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Use the `Set-CsOnlineLisCivicAddress` cmdlet to modify an existing civic address which has not been validated. Validated civic addresses cannot be modified. +Use the `Set-CsOnlineLisCivicAddress` cmdlet to modify limited fields of an existing civic address. + +Editing address using this cmdlet is restricted to the following countries/regions: +Australia, Brazil, Canada, Croatia, Czech Republic, Estonia, Hong Kong, Hungary, Israel, Japan, Latvia, Lithuania, Mexico, New Zealand, Poland, Puerto Rico, Romania, Singapore, South Korea, Slovenia, South Africa, United States. + +If the user runs this cmdlet on one of the unsupported countries, it may interfere with number assignment and potentially is against regulatory requirements, so public use of the API is limited to the above countries/regions. ## EXAMPLES ### Example 1 ```powershell -Set-CsOnlineLisCivicAddress -CivicAddressid a363a9b8-1acd-41de-916a-296c7998a024 -Description "City Center" -CompanyName Contoso +Set-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -Description "City Center" -CompanyName Contoso ``` This example modifies the description and company name of the civic address with the identity a363a9b8-1acd-41de-916a-296c7998a024. ### Example 2 ```powershell -Set-CsOnlineLisCivicAddress -CivicAddressid a363a9b8-1acd-41de-916a-296c7998a024 -Latitude 47.63952 -Longitude -122.12781 -ELIN MICROSOFT_ELIN +Set-CsOnlineLisCivicAddress -CivicAddressId a363a9b8-1acd-41de-916a-296c7998a024 -Latitude 47.63952 -Longitude -122.12781 -ELIN MICROSOFT_ELIN ``` This example modifies the latitude, longitude and ELIN name of the civic address with the identity a363a9b8-1acd-41de-916a-296c7998a024. @@ -56,7 +67,7 @@ Specifies the unique identifier of the civic address to be modified. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -66,13 +77,13 @@ Accept wildcard characters: False ``` ### -City -Specifies a new city for the civic address. +Specifies a new city for the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -82,13 +93,14 @@ Accept wildcard characters: False ``` ### -CityAlias -Short form of the city name. +Short form of the city name. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -98,13 +110,13 @@ Accept wildcard characters: False ``` ### -CompanyName -Specifies a new company name for the civic address. +Specifies a new company name for the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -115,12 +127,13 @@ Accept wildcard characters: False ### -CompanyTaxId Used to store TaxId for regulatory reasons. +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -136,7 +149,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -147,12 +160,15 @@ Accept wildcard characters: False ### -CountryOrRegion Specifies a new country or region for the civic address. +For public use, restricted to the following countries: + +**AU, BR, CA, HR, CZ, EE, HK, HU, IL, JP, LV, LT, MX, NZ, PL, PR, RO, SG, KR, SI, ZA, US** ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -162,13 +178,13 @@ Accept wildcard characters: False ``` ### -Description -Specifies a new description for the civic address. +Specifies a new description for the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -186,7 +202,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -196,13 +212,13 @@ Accept wildcard characters: False ``` ### -HouseNumber -Specifies the new numeric portion of the civic address. +Specifies the new numeric portion of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -215,11 +231,13 @@ Accept wildcard characters: False Specifies the new numeric suffix of the new civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". +This parameter is reserved for internal Microsoft use. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -229,13 +247,13 @@ Accept wildcard characters: False ``` ### -PostalCode -Specifies the new postal code of the civic address. +Specifies the new postal code of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -248,11 +266,13 @@ Accept wildcard characters: False Specifies the new directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE". +This parameter is reserved for internal Microsoft use. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -265,11 +285,13 @@ Accept wildcard characters: False Specifies the new directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". +This parameter is reserved for internal Microsoft use. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -279,13 +301,13 @@ Accept wildcard characters: False ``` ### -StateOrProvince -Specifies the new state or province of the civic address. +Specifies the new state or province of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -295,13 +317,13 @@ Accept wildcard characters: False ``` ### -StreetName -Specifies the new street name of the civic address. +Specifies the new street name of the civic address. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -314,11 +336,13 @@ Accept wildcard characters: False Specifies the new modifier of the street name of the new civic address. The street suffix will typically be something like street, avenue, way, or boulevard. +This parameter is reserved for internal Microsoft use. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -334,7 +358,7 @@ Microsoft internal use only Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -351,7 +375,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -383,7 +407,7 @@ This is used in Direct Routing EGW scenarios. Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -393,13 +417,13 @@ Accept wildcard characters: False ``` ### -Latitude -Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. +Specifies the angular distance of a place north or south of the earth's equator in the decimal degrees format. Publicly editable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -409,13 +433,28 @@ Accept wildcard characters: False ``` ### -Longitude -Specifies the angular distance of a place east or west of the meridian at Greenwich, England, in the decimal degrees format. +Specifies the angular distance of a place east or west of the meridian at Greenwich, England, in the decimal degrees format. Publicly editable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online Required: False Position: Named @@ -435,8 +474,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisCivicAddress](get-csonlineliscivicaddress.md) +[Get-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/get-csonlineliscivicaddress) -[New-CsOnlineLisCivicAddress](new-csonlineliscivicaddress.md) +[New-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/new-csonlineliscivicaddress) -[Remove-CsOnlineLisCivicAddress](remove-csonlineliscivicaddress.md) +[Remove-CsOnlineLisCivicAddress](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliscivicaddress) diff --git a/skype/skype-ps/skype/Set-CsOnlineLisLocation.md b/teams/teams-ps/teams/Set-CsOnlineLisLocation.md similarity index 78% rename from skype/skype-ps/skype/Set-CsOnlineLisLocation.md rename to teams/teams-ps/teams/Set-CsOnlineLisLocation.md index 27ea77f5b8..d93fd56f49 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/Set-CsOnlineLisLocation.md @@ -1,20 +1,19 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinelislocation +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelislocation applicable: Microsoft Teams title: Set-CsOnlineLisLocation schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # Set-CsOnlineLisLocation ## SYNOPSIS -Use the \`Set-CsOnlineLisLocation\` cmdlet to modify an existing emergency dispatch location. -There can be multiple locations in a civic address. +Use the \`Set-CsOnlineLisLocation\` cmdlet to modify an existing emergency dispatch location. There can be multiple locations in a civic address. Typically the civic address designates the building, and locations are specific parts of that building such as a floor, office, or wing. ## SYNTAX @@ -24,7 +23,7 @@ Typically the civic address designates the building, and locations are specific Set-CsOnlineLisLocation -CivicAddressId [-City ] [-CityAlias ] [-CompanyName ] [-CompanyTaxId ] [-Confidence ] [-CountryOrRegion ] [-Description ] [-Elin ] [-Force] [-HouseNumber ] [-HouseNumberSuffix ] [-Latitude ] [-Longitude ] [-PostalCode ] [-PostDirectional ] [-PreDirectional ] - [-StateOrProvince ] [-StreetName ] [-StreetSuffix ] [-WhatIf] [-Confirm] [] + [-StateOrProvince ] [-StreetName ] [-StreetSuffix ] [-IsAzureMapValidationRequired ] [-WhatIf] [-Confirm] [] ``` ### UseLocationId @@ -44,19 +43,14 @@ Set-CsOnlineLisLocation -LocationId 5aa884e8-d548-4b8e-a289-52bfd5265a6e -Locati This example changes the location description of the location specified by its location identity. -### Example 2 -```powershell -Set-CsOnlineLisLocation -CivicAddressId 5687eb59-9039-4e99-bb89-71771d723b7a -Location "B5 2nd Floor" -Elin "TEST_ELIN" -``` - -This example changes the Elin of the location specified by its location identity. - ## PARAMETERS ### -CivicAddressId Specifies the unique identifier of the civic address that contains the location to be modified. Civic address identities can be discovered by using the \`Get-CsOnlineLisCivicAddress\` cmdlet. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: Guid Parameter Sets: UseCivicAddressId @@ -71,9 +65,7 @@ Accept wildcard characters: False ``` ### -LocationId -Specifies the unique identifier of the location to be modified. -If specified, no other address parameters are allowed. -Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. +Specifies the unique identifier of the location to be modified. Location identities can be discovered by using the \`Get-CsOnlineLisLocation\` cmdlet. ```yaml Type: Guid @@ -91,6 +83,8 @@ Accept wildcard characters: False ### -City Specifies the city of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -124,6 +118,8 @@ Accept wildcard characters: False ### -CompanyName Specifies the name of your organization. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -140,6 +136,8 @@ Accept wildcard characters: False ### -CompanyTaxId The company tax ID. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -154,7 +152,8 @@ Accept wildcard characters: False ``` ### -Confidence -This parameter is reserved for internal Microsoft use. + +**Note:** This parameter is not supported and will be deprecated. ```yaml Type: String @@ -172,6 +171,8 @@ Accept wildcard characters: False ### -CountryOrRegion Specifies the country or region of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -188,6 +189,8 @@ Accept wildcard characters: False ### -Description Specifies an administrator defined description of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -202,8 +205,9 @@ Accept wildcard characters: False ``` ### -Elin -Specifies the Emergency Location Identification Number. -This is used in Direct Routing EGW scenarios. +Specifies the Emergency Location Identification Number. This is used in Direct Routing EGW scenarios. + +**Note:** You can set or change the ELIN, but you can't clear its value. If you need to clear the value, you should recreate the location. ```yaml Type: String @@ -218,27 +222,11 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -HouseNumber Specifies the numeric portion of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -256,6 +244,8 @@ Accept wildcard characters: False Specifies the numeric suffix of the civic address. For example, if the property was multiplexed, the HouseNumberSuffix parameter would be the multiplex specifier: "425A Smith Avenue", or "425B Smith Avenue". +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -272,6 +262,8 @@ Accept wildcard characters: False ### -Latitude Specifies the angular distance of a place north or south of the earth's equator using the decimal degrees format. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -288,6 +280,8 @@ Accept wildcard characters: False ### -Longitude Specifies the angular distance of a place east or west of the meridian at Greenwich, England, using the decimal degrees format. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: (All) @@ -301,8 +295,7 @@ Accept pipeline input: True Accept wildcard characters: False ``` ### -Location -Specifies an administrator defined description of the new location. -For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". +Specifies an administrator defined description of the new location. For example, "2nd Floor Cafe", "Main Lobby", or "Office 250". ```yaml Type: String @@ -320,6 +313,8 @@ Accept wildcard characters: False ### -PostalCode Specifies the postal code of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -337,6 +332,8 @@ Accept wildcard characters: False Specifies the directional attribute of the civic address which follows the street name. For example, "425 Smith Avenue NE". +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -351,8 +348,9 @@ Accept wildcard characters: False ``` ### -PreDirectional -Specifies the directional attribute of the civic address which precedes the street name. -For example, "425 NE Smith Avenue ". +Specifies the directional attribute of the civic address which precedes the street name. For example, "425 NE Smith Avenue ". + +**Note:** This parameter is not supported and will be deprecated. ```yaml Type: String @@ -370,6 +368,8 @@ Accept wildcard characters: False ### -StateOrProvince Specifies the state or province of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -386,6 +386,8 @@ Accept wildcard characters: False ### -StreetName Specifies the street name of the civic address. +**Note:** This parameter is not supported and will be deprecated. + ```yaml Type: String Parameter Sets: UseCivicAddressId @@ -400,8 +402,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix -Specifies a modifier of the street name of the civic address. -The street suffix will typically be something like street, avenue, way, or boulevard. +Specifies a modifier of the street name of the civic address. The street suffix will typically be something like street, avenue, way, or boulevard. + +**Note:** This parameter is not supported and will be deprecated. ```yaml Type: String @@ -416,6 +419,40 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -IsAzureMapValidationRequired +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: UseCivicAddressId +Aliases: +Applicable: Microsoft Teans + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -460,8 +497,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +[New-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/new-csonlinelislocation) -[Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +[Get-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/get-csonlinelislocation) -[Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +[Remove-CsOnlineLisLocation](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelislocation) diff --git a/skype/skype-ps/skype/Set-CsOnlineLisPort.md b/teams/teams-ps/teams/Set-CsOnlineLisPort.md similarity index 94% rename from skype/skype-ps/skype/Set-CsOnlineLisPort.md rename to teams/teams-ps/teams/Set-CsOnlineLisPort.md index d1244c9bcc..39f8049001 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisPort.md +++ b/teams/teams-ps/teams/Set-CsOnlineLisPort.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinelisport +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisport applicable: Microsoft Teams title: Set-CsOnlineLisPort schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -14,7 +14,6 @@ ms.reviewer: ## SYNOPSIS Creates a Location Information Server (LIS) port, creates an association between a port and a location, or modifies an existing port and its associated location. The association between a port and location is used in an Enhanced 9-1-1 (E9-1-1) Enterprise Voice implementation to notify an emergency services operator of the caller's location. - ## SYNTAX ``` @@ -46,7 +45,7 @@ Example 2 creates the association between port "0A-25-55-AB-CD-FF" and LocationI Set-CsOnlineLisPort -PortID 12174 -ChassisID 55123 -Description "LisPort 12174" -LocationId efd7273e-3092-4a56-8541-f5c896bb6fee ``` -Example 3 creates the association between port "12174" and LocationId "efd7273e-3092-4a56-8541-f5c896bb6fee". (Note: in this example, ChassisID sub-type is InterfaceName) +Example 3 creates the association between port "12174" and LocationId "efd7273e-3092-4a56-8541-f5c896bb6fee". (Note: in this example, ChassisID sub-type is InterfaceName) ## PARAMETERS @@ -148,7 +147,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -NCSApiUrl This parameter is reserved for internal Microsoft use. @@ -231,6 +229,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +[Get-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisport) -[Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) +[Remove-CsOnlineLisPort](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisport) diff --git a/skype/skype-ps/skype/Set-CsOnlineLisSubnet.md b/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md similarity index 90% rename from skype/skype-ps/skype/Set-CsOnlineLisSubnet.md rename to teams/teams-ps/teams/Set-CsOnlineLisSubnet.md index e716c4d707..ae42f3ce2d 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisSubnet.md +++ b/teams/teams-ps/teams/Set-CsOnlineLisSubnet.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinelissubnet -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelissubnet +applicable: Microsoft Teams title: Set-CsOnlineLisSubnet schema: 2.0.0 -author: kaishuipinggai +author: serdarsoysal ms.author: serdars ms.reviewer: --- @@ -27,7 +27,7 @@ Enhanced 9-1-1 allows an emergency operator to identify the location of a caller The location ID which is associating with the subnet is not required to be the existing location. -LIS subnets must be defined by the Network ID matching the subnet IP range assigned to clients. For example, the network ID for a client IP/mask of 10.10.10.150/25 is 10.10.10.128. For more information, see [Understand TCP/IP addressing and subnetting basics](/troubleshoot/windows-client/networking/tcpip-addressing-and-subnetting). +LIS subnets must be defined by the Network ID matching the subnet IP range assigned to clients. For example, the network ID for a client IP/mask of 10.10.10.150/25 is 10.10.10.128. For more information, see [Understand TCP/IP addressing and subnetting basics](https://learn.microsoft.com/troubleshoot/windows-client/networking/tcpip-addressing-and-subnetting). ## EXAMPLES @@ -45,7 +45,6 @@ Set-CsOnlineLisSubnet -Subnet 2001:4898:e8:6c:90d2:28d4:76a4:ec5e -LocationId f0 Example 2 creates the Location Information Service subnet in IPv6 format "2001:4898:e8:6c:90d2:28d4:76a4:ec5e" associated to Location ID "f037a9ad-4334-455a-a1c5-3838ec0f5d02". - ## PARAMETERS ### -Confirm @@ -55,7 +54,7 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -71,7 +70,7 @@ Specifies the administrator defined description of the Location Information Serv Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -89,7 +88,7 @@ If the Force switch isn't provided in the command, you're prompted for administr Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -105,7 +104,7 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -121,7 +120,7 @@ Specifies the unique identifier of the location to be modified. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: Named @@ -137,7 +136,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -153,7 +152,7 @@ The IP address of the subnet. This value can be either IPv4 or IPv6 format. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 1 @@ -169,7 +168,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -185,7 +184,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: 0 @@ -202,7 +201,7 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -214,23 +213,16 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS - ### System.Guid - ### System.String - ## OUTPUTS - ### System.Object - ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsOnlineLisSwitch.md b/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md similarity index 93% rename from skype/skype-ps/skype/Set-CsOnlineLisSwitch.md rename to teams/teams-ps/teams/Set-CsOnlineLisSwitch.md index eec6e39e42..71e862e8a2 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisSwitch.md +++ b/teams/teams-ps/teams/Set-CsOnlineLisSwitch.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinelisswitch +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinelisswitch applicable: Microsoft Teams title: Set-CsOnlineLisSwitch schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -36,7 +36,7 @@ Example 1 creates a switch with Chassis ID "B8-BE-BF-4A-A3-00", and associates i ## PARAMETERS ### -ChassisID -If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. +If ChassisID sub type is a MAC Address then this value must be in a string format in the following representation nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. Otherwise, (different sub type, such as Interface Name), then this value must be in a string format as set on the switch ```yaml @@ -186,7 +186,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Guid @@ -201,6 +200,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +[Get-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/get-csonlinelisswitch) -[Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) +[Remove-CsOnlineLisSwitch](https://learn.microsoft.com/powershell/module/teams/remove-csonlinelisswitch) diff --git a/skype/skype-ps/skype/Set-CsOnlineLisWirelessAccessPoint.md b/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md similarity index 93% rename from skype/skype-ps/skype/Set-CsOnlineLisWirelessAccessPoint.md rename to teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md index b9b5d89349..75045602f9 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisWirelessAccessPoint.md +++ b/teams/teams-ps/teams/Set-CsOnlineLisWirelessAccessPoint.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlineliswirelessaccesspoint +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineliswirelessaccesspoint applicable: Microsoft Teams title: Set-CsOnlineLisWirelessAccessPoint schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -210,6 +210,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +[Get-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/get-csonlineliswirelessaccesspoint) -[Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) +[Remove-CsOnlineLisWirelessAccessPoint](https://learn.microsoft.com/powershell/module/teams/remove-csonlineliswirelessaccesspoint) diff --git a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md b/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md similarity index 83% rename from skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md index e50f9f867f..aa577953e6 100644 --- a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md +++ b/teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinepstngateway +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstngateway applicable: Microsoft Teams title: Set-CsOnlinePSTNGateway schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,15 +18,13 @@ Modifies the previously defined Session Border Controller (SBC) Configuration th ## SYNTAX ``` -Set-CsOnlinePSTNGateway [-Tenant ] [-SipSignalingPort ] [-FailoverTimeSeconds ] -[-Description ] [-FailoverResponseCodes ] [-ForwardCallHistory ] [-ForwardPai ] [-SendSipOptions ] -[-MaxConcurrentSessions ] [-Enabled ] [-MediaBypass ] [-GatewaySiteId ] -[-GatewayLbrEnabledUserOverride ] [-GatewaySiteLbrEnabled ] [-MediaRelayRoutingLocationOverride ] [-Identity ] -[-BypassMode ] -[-InboundTeamsNumberTranslationRules ] [-InboundPSTNNumberTranslationRules ] -[-OutboundTeamsNumberTranslationRules ] [-PidfloSupported ] [-OutboundPSTNNumberTranslationRules ] -[-Force] [-WhatIf] [-Confirm] [] -``` +Set-CsOnlinePSTNGateway [[-Identity] ] [-BypassMode ] [-Description ] [-Enabled ] + [-FailoverResponseCodes ] [-FailoverTimeSeconds ] [-ForwardCallHistory ] [-ForwardPai ] [-GatewayLbrEnabledUserOverride ] + [-GatewaySiteId ] [-GatewaySiteLbrEnabled ] [-InboundPstnNumberTranslationRules ] [-InboundTeamsNumberTranslationRules ] + [-MaxConcurrentSessions ] [-MediaBypass ] [-MediaRelayRoutingLocationOverride ] [-OutboundPstnNumberTranslationRules ] + [-OutboundTeamsNumberTranslationRules ] [-PidfLoSupported ] [-ProxySbc ] [-SendSipOptions ] [-SipSignalingPort ] + [-WhatIf] [-Confirm] [] + ``` ## DESCRIPTION Use this cmdlet to modify the configuration of the previously created Session Border Controller (SBC) configuration. Each configuration contains specific settings for an SBC. These settings configure such entities as SIP signaling port, whether media bypass is enabled on this SBC, will the SBC send SIP options, specify the limit of maximum concurrent sessions, The cmdlet also let drain the SBC by setting parameter -Enabled to true or false state. When the Enabled parameter set to $false, the SBC will continue existing calls, but all new calls routed to another SBC in a route (if exists). @@ -49,21 +47,6 @@ This example modifies the configuration of an SBC with identity (and FQDN) sbc. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Description Free-format string to describe the gateway. @@ -129,21 +112,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ForwardCallHistory Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False). @@ -190,8 +158,7 @@ Accept wildcard characters: False ``` ### -GatewayLbrEnabledUserOverride -Allow an LBR enabled user working from a network site outside the corporate network, i.e. a network site not configured using tenant network site - typically when working from -home, to make outbound PSTN calls via an LBR enabled gateway. The default value is False. +Allows an LBR enabled user working from a network site outside the corporate network or a network site on the corporate network not configured using a tenant network site to make outbound PSTN calls or receive inbound PSTN calls via an LBR enabled gateway. The default value is False. ```yaml Type: Boolean @@ -224,7 +191,7 @@ Accept wildcard characters: False The parameter is mandatory when modifying an existing SBC. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: Applicable: Microsoft Teams @@ -235,20 +202,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -MaxConcurrentSessions Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours. @@ -280,7 +233,6 @@ Accept wildcard characters: False ``` ### -MediaRelayRoutingLocationOverride -This parameter is reserved for use with managed carriers. Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter. @@ -344,7 +296,7 @@ Accept wildcard characters: False This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -358,7 +310,7 @@ Accept wildcard characters: False Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -372,7 +324,7 @@ Accept wildcard characters: False Creates an ordered list of Teams translation rules, that apply to Teams Number on outbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -386,7 +338,7 @@ Accept wildcard characters: False Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction. ```yaml -Type: String +Type: Object Parameter Sets: (All) Aliases: Required: False @@ -411,10 +363,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -ProxySbc +The FQDN of the proxy SBC. Used in Local Media Optimization configurations. ```yaml -Type: System.Guid +Type: String Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -441,14 +394,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +### -Confirm +Prompts you for confirmation before running the cmdlet. -## INPUTS +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -### System.Management.Automation.PSObject +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -458,8 +422,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +[New-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/new-csonlinepstngateway) -[Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +[Get-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway) -[Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +[Remove-CsOnlinePSTNGateway](https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway) diff --git a/skype/skype-ps/skype/Set-CsOnlinePstnUsage.md b/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md similarity index 61% rename from skype/skype-ps/skype/Set-CsOnlinePstnUsage.md rename to teams/teams-ps/teams/Set-CsOnlinePstnUsage.md index 0ef71df97c..549dcdcc10 100644 --- a/skype/skype-ps/skype/Set-CsOnlinePstnUsage.md +++ b/teams/teams-ps/teams/Set-CsOnlinePstnUsage.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinepstnusage -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage +applicable: Microsoft Teams title: Set-CsOnlinePstnUsage schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,14 +19,7 @@ Modifies a set of strings that identify the allowed online public switched telep ### Identity (Default) ``` -Set-CsOnlinePstnUsage [-Tenant ] [-Usage ] [[-Identity] ] [-Force] - [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsOnlinePstnUsage [-Tenant ] [-Usage ] [-Instance ] [-Force] - [-WhatIf] [-Confirm] [] +Set-CsOnlinePstnUsage [[-Identity] ] [-Usage ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -81,26 +74,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The scope at which these settings are applied. The Identity for this cmdlet is always Global. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -111,49 +89,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling the Get-CsOnlinePstnUsage cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Usage Contains a list of allowable usage strings. These entries can be any string value. ```yaml -Type: PSListModifier +Type: Object Parameter Sets: (All) Aliases: @@ -181,14 +121,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object @@ -196,4 +134,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlinePstnUsage](https://docs.microsoft.com/powershell/module/skype/get-csonlinepstnusage?view=skype-ps) +[Get-CsOnlinePstnUsage](https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage) diff --git a/skype/skype-ps/skype/Set-CsOnlineSchedule.md b/teams/teams-ps/teams/Set-CsOnlineSchedule.md similarity index 81% rename from skype/skype-ps/skype/Set-CsOnlineSchedule.md rename to teams/teams-ps/teams/Set-CsOnlineSchedule.md index 859698d03d..7f4392b0fa 100644 --- a/skype/skype-ps/skype/Set-CsOnlineSchedule.md +++ b/teams/teams-ps/teams/Set-CsOnlineSchedule.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlineschedule -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineschedule +applicable: Microsoft Teams title: Set-CsOnlineSchedule schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsOnlineSchedule @@ -28,13 +28,12 @@ The Set-CsOnlineSchedule cmdlet lets you modify the properties of a schedule. ### -------------------------- Example 1 -------------------------- ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" -$schedule.Name = "Chrismas Holiday" +$schedule.Name = "Christmas Holiday" Set-CsOnlineSchedule -Instance $schedule ``` This example modifies the name of the schedule that has a Id of fa9081d6-b4f3-5c96-baec-0b00077709e5. - ### -------------------------- Example 2 -------------------------- ```powershell $schedule = Get-CsOnlineSchedule -Id "fa9081d6-b4f3-5c96-baec-0b00077709e5" @@ -55,18 +54,16 @@ Set-CsOnlineSchedule -Instance $schedule This example updates an existing holiday schedule, adding a new date/time range to it. - ## PARAMETERS ### -Instance The Instance parameter is the object reference to the schedule to be modified. - ```yaml Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -81,7 +78,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -91,23 +88,21 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable`. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Rtc.Management.Hosted.Online.Models.Schedule The modified instance of the `Microsoft.Rtc.Management.Hosted.Online.Models.Schedule` object. - ## OUTPUTS ### System.Void - ## NOTES ## RELATED LINKS -[New-CsOnlineSchedule](New-CsOnlineSchedule.md) +[New-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/new-csonlineschedule) -[Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) +[Remove-CsOnlineSchedule](https://learn.microsoft.com/powershell/module/teams/remove-csonlineschedule) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceApplicationInstance.md b/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md similarity index 67% rename from skype/skype-ps/skype/Set-CsOnlineVoiceApplicationInstance.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md index 27bd447e3e..f62687992e 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceApplicationInstance.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md @@ -1,166 +1,175 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceapplicationinstance -applicable: Skype for Business Online -title: Set-CsOnlineVoiceApplicationInstance -ms.reviewer: -schema: 2.0.0 -manager: bulenteg -author: jenstrier -ms.author: jenstr ---- - -# Set-CsOnlineVoiceApplicationInstance - -## SYNOPSIS -The `Set-CsOnlineVoiceApplicationInstance` modifies an application instance in Azure Active Directory. - -**Note**: This cmdlet will be deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. The new cmdlets are currently not supported for customers and tenants -that are or have been enabled for Regionally Hosted Meetings for Skype for Business Online. These customers should continue to use Set-CsOnlineVoiceApplicationInstance. - -## SYNTAX -``` -Set-CsOnlineVoiceApplicationInstance [-WhatIf] [-Confirm] [-TelephoneNumber ] [[-Identity] ] - [-Tenant ] [-DomainController ] [-Force] -``` - -## DESCRIPTION -This cmdlet is used to modify an application instance in Azure Active Directory. - -## EXAMPLES - -### Example 1 -```powershell -Set-CsOnlineVoiceApplicationInstance -Identity testra1@contoso.com -TelephoneNumber +14255550100 -``` - -This example sets a phone number to the resource account testra1@contoso.com. - -## 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 -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: DC - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The user principal name (UPN) of the resource account in Azure Active Directory. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -The phone number to be assigned to the resource account. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS - -[New-CsOnlineApplicationInstance](https://docs.microsoft.com/powershell/module/skype/new-csonlineapplicationinstance) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceapplicationinstance +applicable: Microsoft Teams +title: Set-CsOnlineVoiceApplicationInstance +ms.reviewer: +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +--- + +# Set-CsOnlineVoiceApplicationInstance + +## SYNOPSIS +The `Set-CsOnlineVoiceApplicationInstance` modifies an application instance in Microsoft Entra ID. + +**Note**: This cmdlet has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + +## SYNTAX +``` +Set-CsOnlineVoiceApplicationInstance [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Force] + [-TelephoneNumber ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet is used to modify an application instance in Microsoft Entra ID. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsOnlineVoiceApplicationInstance -Identity testra1@contoso.com -TelephoneNumber +14255550100 +``` + +This example sets a phone number to the resource account testra1@contoso.com. + +## 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 +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: DC + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The user principal name (UPN) of the resource account in Microsoft Entra ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TelephoneNumber +The phone number to be assigned to the resource account. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md b/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md similarity index 91% rename from skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md index 932e998de5..e88a324e6f 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroute +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute applicable: Microsoft Teams title: Set-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsOnlineVoiceRoute @@ -61,7 +61,7 @@ BridgeSourcePhoneNumber is an E.164 formatted Operator Connect Conferencing phon When using BridgeSourcePhoneNumber in an online voice route, the OnlinePstnUsages used in the online voice route should only be used in a corresponding OnlineAudioConferencingRoutingPolicy. The same OnlinePstnUsages should not be used in online voice routes that are not using BridgeSourcePhoneNumber. -For more information about Operator Connect Conferencing, please see [Configure Operator Connect Conferencing](https://docs.microsoft.com/microsoftteams/operator-connect-conferencing-configure). +For more information about Operator Connect Conferencing, please see [Configure Operator Connect Conferencing](https://learn.microsoft.com/microsoftteams/operator-connect-conferencing-configure). ```yaml Type: String @@ -201,14 +201,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object @@ -216,8 +214,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps) +[Remove-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md b/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md similarity index 64% rename from skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md index 1911240080..c541ead593 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceroutingpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy +applicable: Microsoft Teams title: Set-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,16 +19,9 @@ Modifies an existing online voice routing policy. Online voice routing policies ### Identity (Default) ``` -Set-CsOnlineVoiceRoutingPolicy [-Tenant ] [-OnlinePstnUsages ] - [-Description ] [-RouteType ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### Instance -``` -Set-CsOnlineVoiceRoutingPolicy [-Tenant ] [-OnlinePstnUsages ] - [-Description ] [-RouteType ] [-Instance ] [-Force] [-WhatIf] [-Confirm] - [] +Set-CsOnlineVoiceRoutingPolicy [[-Identity] ] [-Description ] + [-OnlinePstnUsages ] [-RouteType ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -91,21 +84,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier assigned to the policy when it was created. Online voice routing policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: @@ -118,7 +96,7 @@ To refer to a per-user policy, use syntax similar to this: If you do not specify an Identity, then the `Set-CsOnlineVoiceRoutingPolicy` cmdlet will modify the global policy. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: Identity Aliases: @@ -129,26 +107,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -OnlinePstnUsages A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online voice routing policy. The online PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsOnlinePstnUsage` cmdlet.) ```yaml -Type: PSListModifier +Type: Object Parameter Sets: (All) Aliases: @@ -174,29 +137,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose online voice routing policies are being changed. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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. @@ -214,14 +154,10 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### System.Management.Automation.PSObject - - ## OUTPUTS ### System.Object @@ -229,10 +165,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoiceroutingpolicy?view=skype-ps) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) -[Get-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoiceroutingpolicy?view=skype-ps) +[Get-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoiceroutingpolicy?view=skype-ps) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoiceroutingpolicy?view=skype-ps) +[Remove-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoiceUser.md b/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md similarity index 76% rename from skype/skype-ps/skype/Set-CsOnlineVoiceUser.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceUser.md index 81044042ba..d7f09686d0 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceUser.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceUser.md @@ -1,12 +1,12 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoiceuser -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceuser +applicable: Microsoft Teams title: Set-CsOnlineVoiceUser schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -15,10 +15,9 @@ ms.reviewer: ## SYNOPSIS Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) -**Note**: This cmdlet will be deprecated and no longer supports the ability to add extensions to telephone numbers (for example, "tel:+61281234567;ext=5110"). Use the new -[Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. The new cmdlets are currently not supported for customers and tenants that -are or have been enabled for Regionally Hosted Meetings for Skype for Business Online. These customers should continue to use Set-CsOnlineVoiceUser. +**Note**: This cmdlet has been deprecated. Use the new +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. ## SYNTAX @@ -62,8 +61,8 @@ You can use the `Get-CsOnlineUser` cmdlet to identify the users you want to modi ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -79,7 +78,7 @@ The Confirm switch causes the command to pause processing and requires confirmat Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -95,7 +94,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -112,8 +111,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -131,8 +130,8 @@ This parameter is required for users based in the US. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -149,8 +148,8 @@ Setting the value to $Null clears the user's telephone number. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -165,8 +164,8 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -182,7 +181,7 @@ The WhatIf parameter is not implemented for this cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -192,19 +191,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None - ## OUTPUTS -### -None - ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md b/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md similarity index 66% rename from skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md index 6edc699740..e5f0a4f436 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md @@ -1,33 +1,34 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy -applicable: Microsoft Teams, Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy +applicable: Microsoft Teams title: Set-CsOnlineVoicemailPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # Set-CsOnlineVoicemailPolicy ## SYNOPSIS -Modifies an existing Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +Modifies an existing Online Voicemail policy. Online Voicemail policies determine whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. ## SYNTAX ### Identity (Default) -``` -Set-CsOnlineVoicemailPolicy [[-Identity] ] [-EnableEditingCallAnswerRulesSetting ] [-EnableTranscription ] +```powershell +Set-CsOnlineVoicemailPolicy [[-Identity] ] [-Description ] [-EnableEditingCallAnswerRulesSetting ] [-EnableTranscription ] [-EnableTranscriptionProfanityMasking ] [-EnableTranscriptionTranslation ] [-MaximumRecordingLength ] +[-PostambleAudioFile ] [-PostambleAudioFile ] [-PreamblePostambleMandatory ] [-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Cloud Voicemail service provides organizations with voicemail deposit capabilities for Phone System implementation. -By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. +By default, users enabled for Phone System will be enabled for Cloud Voicemail. The Online Voicemail policy controls whether or not voicemail transcription, profanity masking for the voicemail transcriptions, translation for the voicemail transcriptions, and editing call answer rule settings are enabled for a user. The policies also specify the voicemail maximum recording length for a user and the primary and secondary voicemail system prompt languages. - Voicemail transcription is enabled by default - Transcription profanity masking is disabled by default @@ -35,7 +36,7 @@ By default, users enabled for Phone System will be enabled for Cloud Voicemail. - Editing call answer rule settings is enabled by default - Voicemail maximum recording length is set to 5 minutes by default - Primary and secondary system prompt languages are set to null by default and the user's voicemail language setting is used - + Tenant admin would be able to create a customized online voicemail policy to match the organization's requirements. ## EXAMPLES @@ -54,7 +55,6 @@ Set-CsOnlineVoicemailPolicy -EnableTranscriptionProfanityMasking $false The command shown in Example 2 changes the EnableTranscriptionProfanityMasking to false for tenant level global online voicemail policy when calling without Identity parameter. - ## PARAMETERS ### -Identity @@ -63,8 +63,8 @@ A unique identifier specifying the scope, and in some cases the name, of the pol ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -79,8 +79,8 @@ Controls if editing call answer rule settings are enabled or disabled for a user ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -95,8 +95,8 @@ Allows you to disable or enable voicemail transcription. Possible values are $tr ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -111,8 +111,8 @@ Allows you to disable or enable profanity masking for the voicemail transcriptio ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -127,8 +127,8 @@ Allows you to disable or enable translation for the voicemail transcriptions. Po ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -143,8 +143,8 @@ A duration of voicemail maximum recording length. The length should be between 3 ```yaml Type: Duration Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -153,14 +153,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PostambleAudioFile +The audio file to play to the caller after the user's voicemail greeting has played and before the caller is allowed to leave a voicemail message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -PreambleAudioFile +The audio file to play to the caller before the user's voicemail greeting is played. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreamblePostambleMandatory +Is playing the Pre- or Post-amble mandatory before the caller can leave a message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PrimarySystemPromptLanguage -The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](/powershell/module/skype/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. +The primary (or first) language that voicemail system prompts will be presented in. Must also set SecondarySystemPromptLanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -170,13 +214,13 @@ Accept wildcard characters: False ``` ### -SecondarySystemPromptLanguage -The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](/powershell/module/skype/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. +The secondary language that voicemail system prompts will be presented in. Must also set PrimarySystemPromptLanguage and may not be the same value as PrimarySystemPromptanguage. When set, this overrides the user language choice. See [Set-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings) -PromptLanguage for supported languages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -192,7 +236,7 @@ Specifies whether voicemail and transcription data are shared with the service f Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -208,7 +252,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -224,7 +268,22 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -234,7 +293,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -243,10 +302,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csonlinevoicemailpolicy?view=skype-ps) +[Grant-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoicemailpolicy) diff --git a/skype/skype-ps/skype/Set-CsOnlineVoicemailUserSettings.md b/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md similarity index 85% rename from skype/skype-ps/skype/Set-CsOnlineVoicemailUserSettings.md rename to teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md index 78734115b3..679bea74c8 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoicemailUserSettings.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoicemailUserSettings.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csonlinevoicemailusersettings -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailusersettings +applicable: Microsoft Teams title: Set-CsOnlineVoicemailUserSettings schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -66,7 +66,6 @@ Set-CsOnlineVoicemailUserSettings -Identity user6@contoso.com -DefaultGreetingPr This example changes DefaultGreetingPromptOverwrite setting to "Hi, I am currently not available." for user6@contoso.com. - ## PARAMETERS ### -Identity @@ -75,8 +74,8 @@ The Identity parameter represents the ID of the specific user in your organizati ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -97,8 +96,8 @@ The CallAnswerRule parameter represents the value of the call answer rule, which ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -114,8 +113,8 @@ If the user's normal custom greeting is not set and DefaultGreetingPromptOverwri ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -131,8 +130,8 @@ If the user's out-of-office custom greeting is not set and DefaultOofGreetingPro ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -162,8 +161,8 @@ The OofGreetingEnabled parameter represents whether to play out-of-office greeti ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -178,24 +177,8 @@ The OofGreetingFollowAutomaticRepliesEnabled parameter represents whether to pla ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OofGreetingFollowCalendarEnabled -The OofGreetingFollowCalendarEnabled parameter represents whether to play out-of-office greeting in voicemail deposit scenario when user set out-of-office in calendar. - -```yaml -Type: System.Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -205,7 +188,7 @@ Accept wildcard characters: False ``` ### -PromptLanguage -The PromptLanguage parameter represents the language that is used to play voicemail prompts. +The PromptLanguage parameter represents the language that is used to play voicemail prompts. The following languages are supported: @@ -246,7 +229,7 @@ The following languages are supported: - "ko-KR" (Korean - Korea) - "lt-LT" (Lithuanian - Lithuania) - "lv-LV" (Latvian - Latvia) -- "nl-BE" (Dutch - Begium) +- "nl-BE" (Dutch - Belgium) - "nl-NL" (Dutch - Netherlands) - "nb-NO" (Norwegian, Bokmål - Norway) - "pl-PL" (Polish - Poland) @@ -267,8 +250,8 @@ The following languages are supported: ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -283,8 +266,8 @@ Specifies whether voicemail and transcription data is shared with the service fo ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -295,14 +278,14 @@ Accept wildcard characters: False ### -TransferTarget The TransferTarget parameter represents the target to transfer the call when call answer rule set to PromptOnlyWithTransfer or VoicemailWithTransferOption. -Value of this parameter should be a SIP URI of another user in your organization. +Value of this parameter should be a SIP URI of another user in your organization. For user with Enterprise Voice enabled, a valid telephone number could also be accepted as TransferTarget. ```yaml Type: System.String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -317,8 +300,8 @@ The VoicemailEnabled parameter represents whether to enable voicemail service. I ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -334,7 +317,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -350,7 +333,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -360,7 +343,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -370,10 +353,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Rtc.Management.Hosted.Voicemail.Models.VoicemailUserSettings - ## NOTES - ## RELATED LINKS -[Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) +[Get-CsOnlineVoicemailUserSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailusersettings) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md index b5888d05c9..4ef22599c9 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-csphonenumberassignment +online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Set-CsPhoneNumberAssignment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Set-CsPhoneNumberAssignment @@ -15,37 +16,45 @@ schema: 2.0.0 ## SYNOPSIS This cmdlet will assign a phone number to a user or a resource account (online application instance). -**Note**: The cmdlet is currently not supported for customers and tenants that are or have been enabled for Regionally Hosted Meetings for Skype for Business Online. These -customers should continue to use the Set-CsUser, Set-CsOnlineVoiceUser, Set-CsOnlineApplicationInstance, or Set-CsOnlineVoiceApplicationInstance cmdlets. - ## SYNTAX -### Assignment (Default) +### LocationUpdate (Default) ```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType [-LocationId ] [] +Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [] ``` -### Attribute +### NetworkSiteUpdate ```powershell -Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] +Set-CsPhoneNumberAssignment -PhoneNumber -NetworkSiteId [] ``` -## DESCRIPTION -This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. - -To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) cmdlet. +### Assignment +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType + [-LocationId ] [-NetworkSiteId ] [-AssignmentCategory ] [] +``` -If the cmdlet executes successfully, no result object will be returned. If the cmdlet fails for any reason, a result object will be returned that contains a Code string parameter -and a Message string parameter with additional details of the failure. +### Attribute +```powershell +Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] +``` -**Note**: In Teams PowerShell Module 4.2.1-preview and later we are changing how the cmdlet reports errors. Instead of using a result object, we will be generating an +### ReverseNumberLookup +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] +``` -exception in case of an error and we will be appending the exception to the $Error automatic variable. The cmdlet will also -now support the -ErrorAction parameter to control the execution after an error has occured. +### Notify +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] +``` -**Note**: Macau region is currently not supported for phone number assignment or Enterprise Voice. +## DESCRIPTION +This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. +You can also assign a location to a phone number. +To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlet. ## EXAMPLES @@ -60,8 +69,7 @@ This example assigns the Microsoft Calling Plan phone number +1 (206) 555-1234 t $loc=Get-CsOnlineLisLocation -City Vancouver Set-CsPhoneNumberAssignment -Identity user2@contoso.com -PhoneNumber +12065551224 -PhoneNumberType CallingPlan -LocationId $loc.LocationId ``` -This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location -to the user user2@contoso.com. +This example finds the emergency location defined for the corporate location Vancouver and assigns the Microsoft Calling Plan phone number +1 (206) 555-1224 and location to the user user2@contoso.com. ### Example 3 ```powershell @@ -83,23 +91,92 @@ This example assigns the Direct Routing phone number +1 (425) 555-1225 to the re ### Example 6 ```powershell -Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=100" -PhoneNumberType DirectRouting +Set-CsPhoneNumberAssignment -Identity user4@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting ``` -This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=100 to the user user4@contoso.com. +This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 to the user user4@contoso.com. ### Example 7 ```powershell -$pn=Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=100" -PhoneNumberType DirectRouting -$pn -Code Message ----- ------- -BadRequest Telephone Number '+14255551000;ext=100' has already been assigned to another user +Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } ``` -In this example the assignment cmdlet fails, because the phone number "+14255551000;ext=100" has already been assigned to another user. +This example shows how to use Try/Catch and ErrorAction to perform error checking on the assignment cmdlet failing. +### Example 8 +```powershell +$TempUser = "tempuser@contoso.com" +$OldLoc=Get-CsOnlineLisLocation -City Vancouver +$NewLoc=Get-CsOnlineLisLocation -City Seattle +$Numbers=Get-CsPhoneNumberAssignment -LocationId $OldLoc.LocationId -PstnAssignmentStatus Unassigned -NumberType CallingPlan -CapabilitiesContain UserAssignment +foreach ($No in $Numbers) { + Set-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber -LocationId $NewLoc.LocationId + Remove-CsPhoneNumberAssignment -Identity $TempUser -PhoneNumberType CallingPlan -PhoneNumber $No.TelephoneNumber +} +``` +This example shows how to change the location for unassigned Calling Plan subscriber phone numbers by looping through all the phone numbers, assigning each phone number temporarily with the new location to a user, and then unassigning the phone number again from the user. + +### Example 9 +```powershell +$loc=Get-CsOnlineLisLocation -City Toronto +Set-CsPhoneNumberAssignment -PhoneNumber +12065551224 -LocationId $loc.LocationId +``` +This example shows how to set the location on a phone number. + +### Example 10 +```powershell +$OldLocationId = "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" +$NewLocationId = "951fac72-955e-4734-ab74-cc4c0f761c0b" +# Get all phone numbers in old location +$pns = Get-CsPhoneNumberAssignment -LocationId $OldLocationId +Write-Host $pns.count numbers found in old location $OldLocationId +# Move all those phone numbers to the new location +foreach ($pn in $pns) { + Try { + Set-CsPhoneNumberAssignment -PhoneNumber $pn.TelephoneNumber -LocationId $NewLocationId -ErrorAction Stop + Write-Host $pn.TelephoneNumber was updated to have location $NewLocationId + } + Catch { + Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId + } +} +Write-Host (Get-CsPhoneNumberAssignment -LocationId $OldLocationId).Count numbers found in old location $OldLocationId +Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count numbers found in new location $NewLocationId +``` +This Example shows how to update the LocationID from an old location to a new location for a set of phone numbers. + +### Example 11 +```powershell +Set-CsPhoneNumberAssignment -Identity user3@contoso.com -PhoneNumber +12065551226 -ReverseNumberLookup 'SkipInternalVoip' +``` +This example shows how to turn off reverse number lookup (RNL) on a phone number. When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. This example is only applicable for Direct Routing phone numbers. + +### Example 12 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -AssignmentCategory Private +``` +This example shows how to assign a private phone number (incoming calls only) to a user. +### Example 13 +```powershell +Set-CsPhoneNumberAssignment -Identity user1@contoso.com -PhoneNumber '+14255551234' -PhoneNumberType CallingPlan -LocationId "7fda0c0b-6a3d-48b8-854b-3fbe9dcf6513" -Notify +``` +This example shows how to send an email to Teams phone users informing them about the new telephone number assignment. Note: For assignment of India telephone numbers provided by Airtel, Teams Phone users will automatically receive an email outlining the usage guidelines and restrictions. This notification is mandatory and cannot be opted out of. ## PARAMETERS +### -AssignmentCategory +This parameter indicates the phone number assignment category if it isn't the primary phone number. For example, a Private line can be assigned to a user using '-AssignmentCategory Private'. + +```yaml +Type: System.String +Parameter Sets: (Assignment) +Aliases: +Applicable: Microsoft Teams + +Required: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnterpriseVoiceEnabled Flag indicating if the user or resource account should be EnterpriseVoiceEnabled. @@ -108,10 +185,10 @@ This parameter is mutual exclusive with PhoneNumber. ```yaml Type: System.Boolean Parameter Sets: (Attribute) -Aliases: +Aliases: Applicable: Microsoft Teams -Required: False +Required: True Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -133,15 +210,31 @@ Accept wildcard characters: False ``` ### -LocationId -The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. +The LocationId of the location to assign to the specific user. You can get it using Get-CsOnlineLisLocation. You can set the location on both assigned and unassigned +phone numbers. -Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. +Removal of location from a phone number is supported for Direct Routing numbers and Operator Connect numbers that are not managed by the Service Desk. If you want to remove the location, use the string value null for LocationId. +```yaml +Type: System.String +Parameter Sets: (Assignment, LocationUpdate) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkSiteId +This parameter is reserved for internal Microsoft use. + ```yaml Type: System.String Parameter Sets: (Assignment) Aliases: +Applicable: Microsoft Teams Required: False Default value: None @@ -150,34 +243,60 @@ Accept wildcard characters: False ``` ### -PhoneNumber -The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can not have -"tel:" prefixed. +The phone number to assign to the user or resource account. Supports E.164 format like +12065551234 and non-E.164 format like 12065551234. The phone number can't have "tel:" prefixed. -We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user, but such phone numbers are -not supported to be assigned to a resource account. +We support Direct Routing numbers with extensions using the formats +1206555000;ext=1234 or 1206555000;ext=1234 assigned to a user or resource account. Setting a phone number will automatically set EnterpriseVoiceEnabled to True. ```yaml Type: System.String -Parameter Sets: (Assignment) +Parameter Sets: (Assignment, LocationUpdate) Aliases: -Required: False +Required: True Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PhoneNumberType -The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number -you will typically know which type it is. +The type of phone number to assign to the user or resource account. The supported values are DirectRouting, CallingPlan, and OperatorConnect. When you acquire a phone number you will typically know which type it is. ```yaml Type: System.String Parameter Sets: (Assignment) Aliases: +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseNumberLookup +This parameter is used to control the behavior of reverse number lookup (RNL) for a phone number.When RNL is set to 'SkipInternalVoip', an internal call to this phone number will not attempt to pass through internal VoIP via reverse number lookup in Microsoft Teams. Instead the call will be established through external PSTN connectivity directly. + +```yaml +Type: String +Parameter Sets: (ReverseNumberLookupUpdate, Assignment) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notify +Sends an email to Teams phone user about new telephone number assignment. + +```yaml +Type: Switch +Parameter Sets: (Assignment) +Aliases: + Required: False Default value: None Accept pipeline input: False @@ -196,18 +315,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object ## NOTES -The cmdlet is available in Teams PowerShell module 3.0.0 or later. +The cmdlet is available in Teams PowerShell module 3.0.0 or later. The parameter set LocationUpdate was introduced in Teams PowerShell module 5.3.1-preview. The parameter NetworkSiteId was introduced in Teams PowerShell module 5.5.0. The parameter set NetworkSiteUpdate was introduced in Teams PowerShell module 5.5.1-preview. The cmdlet is only available in commercial and GCC cloud instances. -If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone -number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. +If a user or resource account has a phone number set in Active Directory on-premises and synched into Microsoft 365, you can't use Set-CsPhoneNumberAssignment to set the phone number. You will have to clear the phone number from the on-premises Active Directory and let that change sync into Microsoft 365 first. The previous command for assigning phone numbers to users Set-CsUser had the parameter HostedVoiceMail. Setting HostedVoiceMail for Microsoft Teams users is no longer necessary and that is why the parameter is not available on Set-CsPhoneNumberAssignment. - ## RELATED LINKS -[Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) +[Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) -[Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +[Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsPhoneNumberTag.md b/teams/teams-ps/teams/Set-CsPhoneNumberTag.md new file mode 100644 index 0000000000..c571a93910 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsPhoneNumberTag.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/set-csphonenumbertag +applicable: Microsoft Teams +title: Set-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Set-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows the admin to create and assign a tag to a phone number. + +## SYNTAX + +``` +Set-CsPhoneNumberTag -PhoneNumber -Tag [] +``` + +## DESCRIPTION +This cmdlet allows telephone number administrators to create and assign tags to phone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. Each phone number can have up to 50 tags assigned. To improve readability, it is recommended to avoid assigning too many tags to a single phone number. If the desired tag already exist, the telephone number will get assigned the existing tag. If the tag is not already available, a new tag will be created. [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag) can be used to check a list of already existing tags. The tags can be used as a filter for [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) to filter on certain list. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsPhoneNumberTag -PhoneNumber +123456789 -Tag "HR" +``` +Above example shows how to set a "HR" tag to +123456789 number. + +## PARAMETERS + +### -PhoneNumber +Indicates the phone number for the the tag to be assigned + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Indicates the tag to be assigned or created. + +```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.Boolean + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md b/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md new file mode 100644 index 0000000000..5cd82bcea2 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsSharedCallQueueHistoryTemplate.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsSharedCallQueueHistoryTemplate +applicable: Microsoft Teams +title: Set-CsSharedCallQueueHistoryTemplate +schema: 2.0.0 +manager: +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Set-CsSharedCallQueueHistoryTemplate + +## SYNTAX + +```powershell +Set-CsSharedCallQueueHistoryTemplate -Instance [] +``` + +## DESCRIPTION +Use the Set-SharedCallQueueHistory cmdlet to change a Shared Call Queue History template. + +> [!CAUTION] +> This cmdlet will only work for customers that are participating in the Voice Applications private preview for this feature. General Availability for this functionality has not been determined at this time. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +$SharedCQHistory = Get-CsSharedCallQueueHistory -Id 66f0dc32-d344-4bb1-b524-027d4635515c +$SharedCQHisotry.AnsweredAndOutboundCalls = "AuthorizedUsersAndAgents" +Set-CsSharedCallQueueHistoryTemplate -Instance $SharedCQHistory +``` + +This example sets the AnsweredOutboundCalls value in the Shared Call History Template with the Id `66f0dc32-d344-4bb1-b524-027d4635515c` + +## PARAMETERS + +### -Instance +The instance of the shared call queue history template to change. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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 + +### Microsoft.Rtc.Management.OAA.Models.AutoAttendant + +## NOTES + +## RELATED LINKS + +[New-CsSharedCallQueueHistoryTemplate](./New-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsSharedCallQueueHistoryTemplate](./Get-CsSharedCallQueueHistoryTemplate.md) + +[Remove-CsSharedCallQueueHistoryTemplate](./Remove-CsSharedCallQueueHistoryTemplate.md) + +[Get-CsCallQueue](./Get-CsCallQueue.md) + +[New-CsCallQueue](./New-CsCallQueue.md) + +[Set-CsCallQueue](./Set-CsCallQueue.md) + +[Remove-CsCallQueue](./Remove-CsCallQueue.md) + + + diff --git a/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md new file mode 100644 index 0000000000..2c43c43e51 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAIPolicy.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsAIPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsAIPolicy +schema: 2.0.0 +author: Andy447 +ms.author: andywang +--- + +# Set-CsTeamsAIPolicy + +## SYNOPSIS + +This cmdlet sets Teams AI policy value for users in the tenant. + +## SYNTAX + +```powershell +Set-CsTeamsAIPolicy [[-Identity] ] + [-EnrollFace ] + [-EnrollVoice ] + [-SpeakerAttributionBYOD ] + [-Description ] + [] +``` + +## DESCRIPTION + +The new csTeamsAIPolicy will replace the existing enrollment settings in csTeamsMeetingPolicy, providing enhanced flexibility and control for Teams meeting administrators. Unlike the current single setting, EnrollUserOverride, which applies to both face and voice enrollment, the new policy introduces two distinct settings: EnrollFace and EnrollVoice. These can be individually set to Enabled or Disabled, offering more granular control over biometric enrollments. A new setting, SpeakerAttributionBYOD, is also being added to csTeamsAIPolicy. This allows IT admins to turn off speaker attribution in BYOD scenarios, giving them greater control over how voice data is managed in such environments. This setting can be set to Enabled or Disabled, and will be Enabled by default. In addition to improving the management of face and voice data, the csTeamsAIPolicy is designed to support future AI-related settings in Teams, making it a scalable solution for evolving needs. + +This cmdlet sets the EnrollFace, EnrollVoice, and SpeakerAttributionBYOD values within the csTeamsAIPolicy. These policies can be assigned to users, and each setting can be configured as "Enabled" or "Disabled". " + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Global -EnrollFace Disabled +``` + +Set Teams AI policy "EnrollFace" value to "Disabled" for global as default. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Global -EnrollVoice Disabled +``` + +Set Teams AI policy "EnrollVoice" value to "Disabled" for global as default. + +### Example 3 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Global -SpeakerAttributionBYOD Disabled +``` + +Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for global as default. + +### Example 4 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollFace Enabled +``` + +Set Teams AI policy "EnrollFace" value to "Enabled" for identity "Test". + +### Example 5 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollVoice Enabled +``` + +Set Teams AI policy "EnrollVoice" value to "Enabled" for identity "Test". + +### Example 6 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -SpeakerAttributionBYOD Enabled +``` + +Set Teams AI policy "SpeakerAttributionBYOD" value to "Enabled" for identity "Test". + +### Example 7 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollFace Disabled +``` + +Set Teams AI policy "EnrollFace" value to "Disabled" for identity "Test". + +### Example 8 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -EnrollVoice Disabled +``` + +Set Teams AI policy "EnrollVoice" value to "Disabled" for identity "Test". + +### Example 9 +```powershell +PS C:\> Set-CsTeamsAIPolicy -Identity Test -SpeakerAttributionBYOD Disabled +``` + +Set Teams AI policy "SpeakerAttributionBYOD" value to "Disabled" for identity "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams AI policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollFace +Policy value of the Teams AI EnrollFace policy. EnrollFace controls user access to user face enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollVoice +Policy value of the Teams AI EnrollVoice policy. EnrollVoice controls user access to user voice enrollment in the Teams app settings. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionBYOD +Policy value of the Teams AI SpeakerAttributionBYOD policy. Setting to "Enabled" turns on speaker attribution in BYOD scenarios while "Disabled" will turn off the function. + +```yaml +Type: String +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the Teams AI policy. +For example, the Description might indicate the users the policy should be assigned to. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[New-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaipolicy) + +[Remove-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaipolicy) + +[Get-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaipolicy) + +[Grant-CsTeamsAIPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaipolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md index 193339fb7d..d5d3e1c8a6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md @@ -4,7 +4,7 @@ Module Name: MicrosoftTeams title: Set-CsTeamsAcsFederationConfiguration author: tomkau ms.author: tomkau -online version: https://docs.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsacsfederationconfiguration schema: 2.0.0 --- @@ -12,30 +12,27 @@ schema: 2.0.0 ## SYNOPSIS -**Limited Preview:** Functionality described in this document is currently in limited preview and only authorized organizations have access. This preview version is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). - -This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. For more information, please see [Azure Communication Services and Teams Interoperability](/azure/communication-services/concepts/teams-interop). +This cmdlet is used to manage the federation configuration between Teams and Azure Communication Services. For more information, please see [Azure Communication Services and Teams Interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). ## SYNTAX ```powershell Set-CsTeamsAcsFederationConfiguration - [-EnableAcsUsers ] - [-AllowAllAcsResources ] - [-AllowedAcsResources ] - [-BlockedAcsResources ] - [-WhatIf] - [-Confirm] - [] + [-Identity ] + [-EnableAcsUsers ] + [-AllowedAcsResources ] + [-WhatIf] + [-Confirm] + [] ``` ## DESCRIPTION -Federation between Teams and Azure Communication Services (ACS) allows custom applications built with ACS to connect and communicate with Teams users over voice, video, and chat. These custom applications may be used by end users or by bots, and there is no differentiation in how they appear to Teams users unless the developer of the application explicitly indicates this as part of the communication. For more information, see [Teams interoperability](/azure/communication-services/concepts/teams-interop). +Federation between Teams and Azure Communication Services (ACS) allows external users from ACS to connect and communicate with Teams users over voice and video. These custom applications may be used by end users or by bots, and there is no differentiation in how they appear to Teams users unless the developer of the application explicitly indicates this as part of the communication. For more information, see [Teams interoperability](https://learn.microsoft.com/azure/communication-services/concepts/teams-interop). -This cmdlet is used to enable or disable Teams and ACS federation for a Teams tenant, and to specify which ACS resources can connect to Teams. All ACS resources can be allowed, with possible exclusions, or just selected ACS resources can be allowed (recommended). +This cmdlet is used to enable or disable Teams and ACS federation for a Teams tenant, and to specify which ACS resources can connect to Teams. Only listed ACS resources can be allowed. -You must be a Teams service admin, a Teams communication admin, or Global Administrator for your organization to run the cmdlet. +You must be a Teams service admin or a Teams communication admin for your organization to run the cmdlet. ## EXAMPLES @@ -51,15 +48,7 @@ In this example, federation is enabled for just one ACS resource. ```powershell $allowlist = @('faced04c-2ced-433d-90db-063e424b87b1') -Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowAllAcsResources $False -AllowedAcsResources $allowlist -``` - -### Example 3 -In this example, federation is enabled for all ACS resources except for two. - -```powershell -$blocklist = @('bf19b7db-6960-41e5-a139-2aa373474354','dac4607d-d2d0-40e5-84df-6f32ebd1251b') -Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowAllAcsResources $True -BlockedAcsResources $blocklist +Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources $allowlist ``` ## PARAMETERS @@ -68,22 +57,6 @@ Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowAllAcsResource Set to True to enable federation between Teams and ACS. When set to False, all other parameters are ignored. -During public preview, federation between Teams and ACS is disabled by default. When federation between Teams and ACS is generally available, it will be enabled by default. - -```yaml -Type: Boolean -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAllAcsResources - -When set to True, federation is enabled with all ACS resources except for the resources listed in BlockedAcsResources (which can be null/empty), and the parameter AllowedAcsResources is ignored and should be null/empty. - -When set to False, federation is disabled with all ACS resources, except for the resources listed in AllowedAcsResources (of which there must be at least one), and the parameter BlockedAcsResources is ignored and must be null/empty. - ```yaml Type: Boolean Position: Named @@ -94,9 +67,9 @@ Accept wildcard characters: False ### -AllowedAcsResources -The list of the ACS resources (at least one) for which federation is enabled, when AllowAllAcsResources is set to false. If AllowAllAcsResources is set to true, then this list is ignored and should be null/empty. +The list of the ACS resources (at least one) for which federation is enabled, when EnableAcsUsers is set to true. If EnableAcsUsers is set to false, then this list is ignored and should be null/empty. -The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. A resource cannot be listed in both AllowedAcsResources and BlockedAcsResource. +The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. ```yaml Type: String[] @@ -106,16 +79,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockedAcsResources - -The list of the ACS resources (if any) for which federation is disabled, when AllowAllAcsResources is set to true. If AllowAllAcsResources is set to false, then this list is ignored and must be null/empty. - -The ACS resources are listed using their immutable resource id, which is a guid that can be found on the Azure portal. A resource cannot be listed in both AllowedAcsResources and BlockedAcsResource. +### -Identity +Specifies the collection of tenant federation configuration settings to be modified. Because each tenant is limited to a single, global collection of federation settings there is no need include this parameter when calling the Set-CsTenantFederationConfiguration cmdlet. If you do choose to use the Identity parameter, you must also include the Tenant parameter. For example: +`Set-CsTenantFederationConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` ```yaml -Type: String[] +Type: String +Parameter Sets: (All) +Aliases: + +Required: False Position: Named -Default value: Empty/Null +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -131,10 +106,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) +[Get-CsTeamsAcsFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsacsfederationconfiguration) -[New-CsExternalAccessPolicy](/powershell/module/skype/new-csexternalaccesspolicy?view=skype-ps) +[New-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/new-csexternalaccesspolicy) -[Set-CsExternalAccessPolicy](/powershell/module/skype/set-csexternalaccesspolicy?view=skype-ps) +[Set-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/set-csexternalaccesspolicy) -[Grant-CsExternalAccessPolicy](/powershell/module/skype/grant-csexternalaccesspolicy?view=skype-ps) +[Grant-CsExternalAccessPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csexternalaccesspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md new file mode 100644 index 0000000000..58ff1553f7 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md @@ -0,0 +1,319 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsapppermissionpolicy +applicable: Microsoft Teams +title: Set-CsTeamsAppPermissionPolicy +schema: 2.0.0 +ms.reviewer: mhayrapetyan +manager: prkosh +author: serdarsoysal +ms.author: serdars +--- + +# Set-CsTeamsAppPermissionPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. This cmdlet is not supported for tenants that migrated to app centric management feature as it replaced permission policies. While the cmdlet may succeed, the changes aren't applied to the tenant. + +As an admin, you can use app permission policies to allow or block apps for your users. Learn more about the app permission policies at and about app centric management at . + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsAppPermissionPolicy [-Tenant ] [-DefaultCatalogApps <>] [-GlobalCatalogApps <>] + [-PrivateCatalogApps <>] [-Description ] [-DefaultCatalogAppsType ] + [-GlobalCatalogAppsType ] [-PrivateCatalogAppsType ] [[-Identity] ] [-Force] + [-WhatIf] [-Confirm] [] +``` + +### Instance +``` +Set-CsTeamsAppPermissionPolicy [-Tenant ] [-DefaultCatalogApps <>] [-GlobalCatalogApps <>] + [-PrivateCatalogApps <>] [-Description ] [-DefaultCatalogAppsType ] + [-GlobalCatalogAppsType ] [-PrivateCatalogAppsType ] [-Instance ] [-Force] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app permission polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app permission policies to enable or block specific apps for your users. Learn more about the App Setup Policies: . + +## EXAMPLES + +### Example 1 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppPermissionPolicy -Identity Set-$identity +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -DefaultCatalogApps @()-GlobalCatalogAppsType -GlobalCatalogApps @() BlockedAppList -PrivateCatalogAppsType BlockedAppList -PrivateCatalogApps @() +``` +This example allows all Microsoft apps, third-party apps, and custom apps. No apps are blocked. + +### Example 2 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +New-CsTeamsAppPermissionPolicy -Identity Set-$identity +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps @() -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps @() +``` +This example blocks all Microsoft apps, third-party apps, and custom apps. No apps are allowed. + +### Example 3 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -GlobalCatalogAppsType AllowedAppList -PrivateCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() + +$ListsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp -Property @{Id="0d820ecd-def2-4297-adad-78056cde7c78"} +$OneNoteApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp -Property @{Id="26bc2873-6023-480c-a11b-76b66605ce8c"} +$DefaultCatalogAppList = @($ListsApp,$OneNoteApp) +# set allow Lists and OneNote apps and block other Microsoft apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -DefaultCatalogApps $DefaultCatalogAppList +``` +This example allows Microsoft Lists and OneNote apps and blocks other Microsoft apps. Microsoft Lists and OneNote can be installed by your users. + +### Example 4 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType AllowedAppList -GlobalCatalogAppsType AllowedAppList -PrivateCatalogAppsType AllowedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() +$TaskListApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp -Property @{Id="57c81e84-9b7b-4783-be4e-0b7ffc0719af"} +$OnePlanApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp -Property @{Id="ca0540bf-6b61-3027-6313-a7cb4470bf1b"} +$GlobalCatalogAppList = @($TaskListApp,$OnePlanApp) +# set allow TaskList and OnePlan apps and block other Third-party apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -GlobalCatalogAppsType AllowedAppList -GlobalCatalogApps $GlobalCatalogAppList +``` +This example allows third-party TaskList and OnePlan apps and blocks other third-party apps. TaskList and OnePlan can be installed by your users. + +### Example 5 + +```powershell +$identity = "TestTeamsAppPermissionPolicy" + (Get-Date -Format FileDateTimeUniversal) +# create a new Teams app permission policy and block all apps +New-CsTeamsAppPermissionPolicy -Identity Set-$identity -DefaultCatalogAppsType BlockedAppList -GlobalCatalogAppsType BlockedAppList -PrivateCatalogAppsType BlockedAppList -DefaultCatalogApps @() -GlobalCatalogApps @() -PrivateCatalogApps @() +$GetStartApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp -Property @{Id="f8374f94-b179-4cd2-8343-9514dc5ea377"} +$TestBotApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp -Property @{Id="47fa3584-9366-4ce7-b1eb-07326c6ba799"} +$PrivateCatalogAppList = @($GetStartApp,$TestBotApp) +# set allow TaskList and OnePlan apps and block other custom apps +Set-CsTeamsAppPermissionPolicy -Identity Set-$identity -PrivateCatalogAppsType AllowedAppList -PrivateCatalogApps $PrivateCatalogAppList +``` +This example allows custom GetStartApp and TestBotApp apps and blocks other custom apps. GetStartApp and TestBotApp can be installed by your users. + +## 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 +``` + +### -DefaultCatalogApps +Choose which Teams apps published by Microsoft or its partners can be installed by your users. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultCatalogAppsType +Choose to allow or block the installation of Microsoft apps. Values that can be used: AllowedAppList, BlockedAppList. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of app setup permission policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalCatalogApps +Choose which Teams apps published by a third party can be installed by your users. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GlobalCatalogAppsType +Choose to allow or block the installation of third-party apps. Values that can be used: AllowedAppList, BlockedAppList. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of App setup permission policy. If empty, all Identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PrivateCatalogApps +Choose to allow or block the installation of custom apps. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateCatalogAppsType +Choose which custom apps can be installed by your users. Values that can be used: AllowedAppList, BlockedAppList. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.DefaultCatalogApp +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.GlobalCatalogApp +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PrivateCatalogApp + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md new file mode 100644 index 0000000000..1e6e8b5c3a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsappsetuppolicy +applicable: Microsoft Teams +title: Set-CsTeamsAppSetupPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsAppSetupPolicy + +## SYNOPSIS +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. + +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsAppSetupPolicy [[-Identity] ] + [-AllowSideLoading ] + [-AllowUserPinning ] + [-AppPresetList ] + [-Confirm] + [-Description ] + [-Force] + [-PinnedAppBarApps ] + [-PinnedCallingBarApps ] + [-PinnedMessageBarApps ] + [-AppPresetMeetingList ] + [-AdditionalCustomizationApps ] + [-Tenant ] + [-WhatIf] + [] +``` + +### Instance +```powershell +Set-CsTeamsAppSetupPolicy [-Instance ] + [-AllowSideLoading ] + [-AllowUserPinning ] + [-AppPresetList ] + [-Confirm] + [-Description ] + [-Force] + [-PinnedAppBarApps ] + [-PinnedCallingBarApps ] + [-PinnedMessageBarApps ] + [-AppPresetMeetingList ] + [-AdditionalCustomizationApps ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION +**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. + +As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. + +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . + +## EXAMPLES + +### Example 1 + +```powershell +# Create new teams app setup policy named "Set-Test". +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AllowUserPinning $true -AllowSideLoading $false +``` + +Step 1: Create a new Teams app setup policy named "Set-Test". +Step 2: Set AllowUserPinning as true, AllowSideLoading as false. + +### Example 2 + +```powershell +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"} +$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"} +$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"} +$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp) +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedAppBarApps $PinnedAppBarApps +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps. +Step 3: Settings to pin these apps to the app bar in Teams client. + +### Example 3 + +```powershell +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$PinnedMessageBarApps = @($VivaConnectionsApp) +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedMessageBarApps $PinnedMessageBarApps +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set VivaConnectionsApp as PinnedAppBarApps. +Step 3: Settings to pin these apps to the messaging extension in Teams client. + +### Example 4 + +```powershell +New-CsTeamsAppSetupPolicy -Identity 'Set-Test' +$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"} +$AppPresetList = @($VivaConnectionsApp) +Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AppPresetList $AppPresetList +``` + +Step 1: Create new teams app setup policy named "Set-Test". +Step 2: Set VivaConnectionsApp as AppPresetList +Step 3: Settings to install these apps in your users' personal Teams environment. + +## PARAMETERS + +### -Identity +Name of app setup policy. If empty, all identities will be used by default. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Do not use. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AllowSideLoading +This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your organization without having to submit it to the Teams app store. Uploading a custom app also lets you test an app before you distribute it more widely by only assigning it to a single user or group of users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserPinning +If you turn this on, the user's existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user's existing app pins will be removed and replaced with the apps defined in this policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetList +Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdditionalCustomizationApps +This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for supportive first-party (1P) and third-party (3P) apps, enhancing corporate connections to employees through brand expression and stimulating app awareness and usage. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppPresetMeetingList +This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick access to the relevant apps during meetings. + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description of App setup policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Do not use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedAppBarApps +Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that users need the most and promote ease of access. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PinnedMessageBarApps +Apps will be pinned in messaging extensions and into the ellipsis menu. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Do not use. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp + +### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsAudioConferencingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md similarity index 84% rename from skype/skype-ps/skype/Set-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md index 473136d7f3..aee67a3709 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAudioConferencingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/set-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy +title: Set-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -39,10 +40,10 @@ In this example, AllowTollFreeDialin is set to false. All other policy propertie ### EXAMPLE 2 ``` -PS C:\> Set-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $True -MeetingInvitePhoneNumbers “+49695095XXXXX”,”+353156YYYYY”,”+1800856ZZZZZ” +PS C:\> Set-CsTeamsAudioConferencingPolicy -Identity "EMEA Users" -AllowTollFreeDialin $True -MeetingInvitePhoneNumbers "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ" ``` -In this example, two different property values are configured: AllowTollFreeDialIn is set to True and -MeetingInvitePhoneNumbers is set to include the following Toll and Toll free numbers - “+49695095XXXXX”,”+353156YYYYY”,”+1800856ZZZZZ” other policy properties will be left as previously assigned. +In this example, two different property values are configured: AllowTollFreeDialIn is set to True and -MeetingInvitePhoneNumbers is set to include the following Toll and Toll free numbers - "+49695095XXXXX","+353156YYYYY","+1800856ZZZZZ" other policy properties will be left as previously assigned. ## PARAMETERS @@ -77,7 +78,7 @@ Accept wildcard characters: False ``` ### -Identity -Unique identifier for the policy to be Set. To set the global policy, use this syntax: -Identity global. To set a per-user policy use syntax similar to this: -Identity “Emea Users”. +Unique identifier for the policy to be Set. To set the global policy, use this syntax: -Identity global. To set a per-user policy use syntax similar to this: -Identity "Emea Users". If this parameter is not included, the Set-CsTeamsAudioConferencingPolicy cmdlet will modify the Global policy. ```yaml @@ -166,8 +167,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) -[New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) +[New-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) \ No newline at end of file +[Grant-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsaudioconferencingpolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md similarity index 72% rename from skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md index d386d63349..27aaba2f36 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md @@ -1,213 +1,203 @@ ---- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamscallholdpolicy -applicable: Microsoft Teams -title: Set-CsTeamsCallHoldPolicy -schema: 2.0.0 -ms.reviewer: -manager: abnair -ms.author: jomarque -author: joelhmarquez ---- - -# Set-CsTeamsCallHoldPolicy - -## SYNOPSIS - -Modifies an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. - - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsCallHoldPolicy [-Tenant ] [-Description ] [-AudioFileId ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsCallHoldPolicy [-Tenant ] [-Description ] [-AudioFileId ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams call hold policies are used to customize the call hold experience for teams clients. - -When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. - -Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -AudioFileId "c65233-ac2a27-98701b-123ccc" -``` - -The command shown in Example 1 modifies an existing per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. - -This policy is re-assigned the audio file ID to be used to: c65233-ac2a27-98701b-123ccc, which is the ID referencing an audio file that was uploaded using the Import-CsOnlineAudioFile cmdlet. - -Any Microsoft Teams users who are assigned this policy will have their call holds customized such that the user being held will hear the audio file specified by AudioFileId. - -### Example 2 -```powershell -PS C:\> Set-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -Description "country music" -``` - -The command shown in Example 2 modifies an existing per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. - -This policy is re-assigned the description from its existing value to "country music". - -## PARAMETERS - -### -AudioFileId -A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams call hold policy. - -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Unique identifier assigned to the Teams call hold policy. - -Use the "Global" Identity if you wish modify the policy set for the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) - -[New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) - -[Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) - -[Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) - -[Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallholdpolicy +applicable: Microsoft Teams +title: Set-CsTeamsCallHoldPolicy +schema: 2.0.0 +ms.reviewer: +manager: abnair +ms.author: serdars +author: serdarsoysal +--- + +# Set-CsTeamsCallHoldPolicy + +## SYNOPSIS + +Modifies an existing Teams call hold policy in your tenant. The Teams call hold policy is used to customize the call hold experience for Teams clients. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCallHoldPolicy [-Identity] [-Description ] [-AudioFileId ] [-StreamingSourceUrl ] [-StreamingSourceAuthType ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams call hold policies are used to customize the call hold experience for teams clients. + +When Microsoft Teams users participate in calls, they have the ability to hold a call and have the other entity in the call listen to an audio file during the duration of the hold. + +Assigning a Teams call hold policy to a user sets an audio file to be played during the duration of the hold. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -AudioFileId "c65233-ac2a27-98701b-123ccc" +``` + +The command shown in Example 1 modifies an existing per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. + +This policy is re-assigned the audio file ID to be used to: c65233-ac2a27-98701b-123ccc, which is the ID referencing an audio file that was uploaded using the Import-CsOnlineAudioFile cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their call holds customized such that the user being held will hear the audio file specified by AudioFileId. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsCallHoldPolicy -Identity "ContosoPartnerTeamsCallHoldPolicy" -Description "country music" +``` + +The command shown in Example 2 modifies an existing per-user Teams call hold policy with the Identity ContosoPartnerTeamsCallHoldPolicy. + +This policy is re-assigned the description from its existing value to "country music". + +## PARAMETERS + +### -Identity +Unique identifier of the Teams call hold policy being modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams call hold policy. + +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioFileId +A string representing the ID referencing an audio file uploaded via the Import-CsOnlineAudioFile cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceUrl +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingSourceAuthType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallholdpolicy) + +[New-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallholdpolicy) + +[Grant-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallholdpolicy) + +[Remove-CsTeamsCallHoldPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallholdpolicy) + +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) diff --git a/skype/skype-ps/skype/Set-CsTeamsCallParkPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md similarity index 83% rename from skype/skype-ps/skype/Set-CsTeamsCallParkPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md index da7c4372cf..14c75e129a 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallParkPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsCallParkPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamscallparkpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallparkpolicy +applicable: Microsoft Teams title: Set-CsTeamsCallParkPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsCallParkPolicy @@ -16,18 +16,24 @@ ms.reviewer: The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Set-CsTeamsCallParkPolicy cmdlet lets you update a policy that has already been created for your organization. -NOTE: The call park feature currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. +NOTE: The call park feature is currently available in desktop, mobile, and web clients. Supported with TeamsOnly mode. ## SYNTAX -### Identity (Default) +```powershell +Set-CsTeamsCallParkPolicy [-AllowCallPark ] [-Description ] [[-Identity] ] + [-ParkTimeoutSeconds ] [-PickupRangeEnd ] [-PickupRangeStart ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] ``` + +### Identity (Default) +```powershell Set-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [-PickupRangeStart ] [-PickupRangeEnd ] [-ParkTimeoutSeconds ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance -``` +```powershell Set-CsTeamsCallParkPolicy [-Tenant ] [-AllowCallPark ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -215,15 +221,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md new file mode 100644 index 0000000000..1f3a0f0fe7 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md @@ -0,0 +1,738 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscallingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsCallingPolicy +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: alejandramu +--- + +# Set-CsTeamsCallingPolicy + +## SYNOPSIS +Use this cmdlet to update values in existing Teams Calling Policies. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsCallingPolicy [-Identity] + [-AIInterpreter ] + [-AllowCallForwardingToPhone ] + [-AllowCallForwardingToUser ] + [-AllowCallGroups ] + [-AllowCallRedirect ] + [-AllowCloudRecordingForCalls ] + [-AllowDelegation ] + [-AllowPrivateCalling ] + [-AllowSIPDevicesCalling ] + [-AllowTranscriptionForCalling ] + [-AllowVoicemail ] + [-AllowWebPSTNCalling ] + [-AutoAnswerEnabledType ] + [-BusyOnBusyEnabledType ] + [-CallRecordingExpirationDays ] + [-CallingSpendUserLimit ] + [-Confirm] + [-Copilot ] + [-EnableSpendLimits ] + [-EnableWebPstnMediaBypass ] + [-Force] + [-InboundFederatedCallRoutingTreatment ] + [-InboundPstnCallRoutingTreatment ] + [-LiveCaptionsEnabledTypeForCalling ] + [-MusicOnHoldEnabledType ] + [-PopoutAppPathForIncomingPstnCalls ] + [-PopoutForIncomingPstnCalls ] + [-PreventTollBypass ] + [-SpamFilteringEnabledType ] + [-VoiceSimulationInInterpreter ] + [-RealTimeText ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Teams Calling Policy controls which calling and call forwarding features are available to users in Microsoft Teams. This cmdlet allows admins to set values in +a given Calling Policy instance. + +Only the parameters specified are changed. Other parameters keep their existing values. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Set-CsTeamsCallingPolicy -Identity Global -AllowPrivateCalling $true +``` + +Sets the value of the parameter AllowPrivateCalling in the Global (default) Teams Calling Policy instance. + +### Example 2 +``` +PS C:\> Set-CsTeamsCallingPolicy -Identity HRPolicy -LiveCaptionsEnabledTypeForCalling Disabled +``` + +Sets the value of the parameter LiveCaptionsEnabledTypeForCalling to Disabled in the Teams Calling Policy instance called HRPolicy. + +## PARAMETERS + +### -Identity +Name of the policy instance being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToPhone +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to any phone number. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallForwardingToUser +Enables the user to configure in the Microsoft Teams client call forwarding or simultaneous ringing of inbound calls to other users in your tenant. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallGroups +Enables the user to configure call groups in the Microsoft Teams client and that inbound calls should be routed to call groups. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallRedirect +Setting this parameter enables local call redirection for SIP devices connecting via the Microsoft Teams SIP gateway. + +Valid options are: + +- Enabled: Enables the user to redirect an incoming call. +- Disabled: The user is not enabled to redirect an incoming call. +- UserOverride: This option is not available for use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecordingForCalls +Determines whether cloud recording is allowed in a user's 1:1 Teams or PSTN calls. Set this to True to allow the user to be able to record 1:1 calls. Set this to False to prohibit the user from recording 1:1 calls. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDelegation +Enables the user to configure delegation in the Microsoft Teams client and that inbound calls to be routed to delegates; allows delegates to make outbound calls on behalf of the users for whom they have delegated permissions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateCalling +Controls all calling capabilities in Teams. Turning this off will turn off all calling functionality in Teams. +If you use Skype for Business for calling, this policy will not affect calling functionality in Skype for Business. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSIPDevicesCalling +Determines whether the user is allowed to use a SIP device for calling on behalf of a Teams client. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscriptionForCalling +Determines whether post-call transcriptions are allowed. Set this to True to allow. Set this to False to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVoicemail +Enables inbound calls to be routed to voicemail. + +Valid options are: + +- AlwaysEnabled: Calls are always forwarded to voicemail on unanswered after ringing for thirty seconds, regardless of the unanswered call forward setting for the user. +- AlwaysDisabled: Calls are never routed to voicemail, regardless of the call forward or unanswered settings for the user. Voicemail isn't available as a call forwarding or unanswered setting in Teams. +- UserOverride: Calls are forwarded to voicemail based on the call forwarding and/or unanswered settings for the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWebPSTNCalling +Allows PSTN calling from the Teams web client. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAnswerEnabledType + +Allow admins to enable or disable Auto-answer settings for users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BusyOnBusyEnabledType +Setting this parameter lets you configure how incoming calls are handled when a user is already in a call or conference or has a call placed on hold. + +Valid options are: + +- Enabled: New or incoming calls will be rejected with a busy signal. +- Unanswered: The user's unanswered settings will take effect, such as routing to voicemail or forwarding to another user. +- Disabled: New or incoming calls will be presented to the user. +- UserOverride: Users can set their busy options directly from call settings in Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallingSpendUserLimit +The maximum amount a user can spend on outgoing PSTN calls, including all calls made through Pay-as-you-go Calling Plans and any overages on plans with bundled minutes. + +Possible values: any positive integer + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallRecordingExpirationDays +Sets the expiration of the recorded 1:1 calls. Default is 60 days. + +```yaml +Type: Long +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +Setting this parameter lets you control how Copilot is used during calls and if transcription is needed to be turned on and saved after the call. + +Valid options are: +- Enabled: Copilot can work with or without transcription during calls. This is the default value. +- EnabledWithTranscript: Copilot will only work when transcription is enabled during calls. +- Disabled: Copilot is disabled for calls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the calling policy. For example, the Description might indicate the users to whom the policy should be assigned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSpendLimits +This setting allows an admin to enable or disable spend limits on PSTN calls for their user base. + +Possible values: + +- True +- False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableWebPstnMediaBypass + +Determines if MediaBypass is enabled for PSTN calls on specified Web platforms. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundFederatedCallRoutingTreatment +Setting this parameter lets you control how inbound federated calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound federated call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. +- Voicemail: The inbound federated call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InboundPstnCallRoutingTreatment +Setting this parameter lets you control how inbound PSTN calls should be routed. + +Valid options are: + +- RegularIncoming: No changes are made to default inbound routing. This is the default setting. +- Unanswered: The inbound PSTN call will be routed according to the called user's unanswered call settings and the call will not be presented to the called user. The called user will see a missed call notification. If the called user has not enabled unanswered call settings the call will be disconnected. +- Voicemail: The inbound PSTN call will be routed directly to the called user's voicemail and the call will not be presented to the user. If the called user does not have voicemail enabled the call will be disconnected. +- UserOverride: Users can determine their PSTN call routing choice from call settings in the Teams app. + +Setting this parameter to Unanswered or Voicemail will have precedence over other call forwarding settings like call forward/simultaneous ringing to delegate, call groups, or call forwarding. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: RegularIncoming +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledTypeForCalling +Determines whether real-time captions are available for the user in Teams calls. + +Valid options are: + +- DisabledUserOverride: Allows the user to turn on live captions. +- Disabled: Prohibits the user from turning on live captions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MusicOnHoldEnabledType +Setting this parameter allows you to turn on or turn off the music on hold when a caller is placed on hold. + +Valid options are: + +- Enabled: Music on hold is enabled. This is the default. +- Disabled: Music on hold is disabled. +- UserOverride: For now, setting the value to UserOverride is the same as Enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutAppPathForIncomingPstnCalls +Setting this parameter allows you to set the PopoutForIncomingPstnCalls setting's URL path of the website to launch upon receiving incoming PSTN calls. This parameter accepts an HTTPS URL with less than 1024 characters. The URL can contain a `{phone}` placeholder that is replaced with the caller's PSTN number in E.164 format when launched. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: "" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopoutForIncomingPstnCalls +Setting this parameter allows you to control the tenant users' ability to launch an external website URL automatically in the browser window upon incoming PSTN calls for specific users or user groups. Valid options are Enabled and Disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventTollBypass +Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. + +> [!NOTE] +> Do not set this parameter to True for Calling Plan or Operator Connect users as it will prevent successful call routing. This setting only works with Direct Routing which is configured to handle location-based routing restrictions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpamFilteringEnabledType +Determines if spam detection is enabled for inbound PSTN calls. + +Possible values: + +- Enabled: Spam detection is enabled. In case the inbound call is considered spam, the user will get a "Spam Likely" label in Teams. +- Disabled: Spam detection is disabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a call, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +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: Microsoft Teams + +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). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscallingpolicy) + +[Remove-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscallingpolicy) + +[Grant-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscallingpolicy) + +[New-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscallingpolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md similarity index 69% rename from skype/skype-ps/skype/Set-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md index 0b85febccf..a6e29ca6ed 100644 --- a/skype/skype-ps/skype/Set-CsTeamsChannelsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamschannelspolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy +applicable: Microsoft Teams title: Set-CsTeamsChannelsPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsChannelsPolicy @@ -21,15 +21,15 @@ The CsTeamsChannelsPolicy allows you to manage features related to the Teams and ### Identity (Default) ``` Set-CsTeamsChannelsPolicy [-Tenant ] [-AllowOrgWideTeamCreation ] - [-AllowPrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] - [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] + [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] + [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] [-ThreadedChannelCreation ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance ``` Set-CsTeamsChannelsPolicy [-Tenant ] [-AllowOrgWideTeamCreation ] - [-AllowPrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] + [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -43,14 +43,14 @@ This cmdlet allows you to update existing policies of this type. ### Example 1 ```powershell -PS C:\> Set-CsTeamsChannelsPolicy -Identity StudentPolicy -AllowPrivateTeamDiscovery $true +PS C:\> Set-CsTeamsChannelsPolicy -Identity StudentPolicy -EnablePrivateTeamDiscovery $true ``` This example shows updating an existing policy with name "StudentPolicy" and enabling Private Team Discovery. ## PARAMETERS -### -AllowPrivateTeamDiscovery +### -EnablePrivateTeamDiscovery Determines whether a user is allowed to discover private teams in suggestions and search results. Set this to TRUE to allow. Set this FALSE to prohibit. ```yaml @@ -186,7 +186,7 @@ Accept wildcard characters: False ``` ### -AllowChannelSharingToExternalUser -Owners of a shared channel can invite external users to join the channel if Azure AD external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](/microsoftteams/teams-policies). +Owners of a shared channel can invite external users to join the channel if Microsoft Entra external sharing policies are configured. If the channel has been shared with an external member or team, they will continue to have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -214,7 +214,7 @@ Accept wildcard characters: False ``` ### -AllowUserToParticipateInExternalSharedChannel -Users and teams can be invited to external shared channels if Azure AD external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](/microsoftteams/teams-policies). +Users and teams can be invited to external shared channels if Microsoft Entra external sharing policies are configured. If a team in your organization is part of an external shared channel, new team members will have access to the channel even if this parameter is set to FALSE. For more information, see [Manage channel policies in Microsoft Teams](https://learn.microsoft.com/microsoftteams/teams-policies). ```yaml Type: Boolean @@ -227,15 +227,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThreadedChannelCreation +This setting enables/disables Threaded Channel creation and editing. + +Possible Values: +- Enabled: Users are allowed to create and edit Threaded Channels. +- Disabled: Users are not allowed to create and edit Threaded Channels. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object @@ -244,10 +261,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[New-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamschannelspolicy) +[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamschannelspolicy) +[Get-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamschannelspolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md index 1a8e71b655..d2685ba41e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md @@ -1,20 +1,20 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsclientconfiguration -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsclientconfiguration +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Set-CsTeamsClientConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsClientConfiguration ## SYNOPSIS -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. +The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and how Surface Hub devices can interact with Skype for Business meetings. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. ## SYNTAX @@ -25,8 +25,8 @@ Set-CsTeamsClientConfiguration [-Tenant ] [-AllowEmailIntoChannel < [-AllowShareFile ] [-AllowOrganizationTab ] [-AllowSkypeBusinessInterop ] [-AllowTBotProactiveMessaging ] [-ContentPin ] [-AllowResourceAccountSendMessage ] [-ResourceAccountContentAccess ] [-AllowGuestUser ] - [-AllowScopedPeopleSearchandAccess ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] + [-AllowScopedPeopleSearchandAccess ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] + [] ``` ### Instance @@ -36,14 +36,14 @@ Set-CsTeamsClientConfiguration [-Tenant ] [-AllowEmailIntoChannel < [-AllowShareFile ] [-AllowOrganizationTab ] [-AllowSkypeBusinessInterop ] [-AllowTBotProactiveMessaging ] [-ContentPin ] [-AllowResourceAccountSendMessage ] [-ResourceAccountContentAccess ] [-AllowGuestUser ] - [-AllowScopedPeopleSearchandAccess ] [-Instance ] [-Force] [-WhatIf] [-Confirm] - [] + [-AllowScopedPeopleSearchandAccess ] [-Instance ] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and whether or not meeting room devices running teams are can display content from user accounts. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. +The TeamsClientConfiguration allows IT admins to control the settings that can be accessed via Teams clients across their organization. This configuration includes settings like which third party cloud storage your organization allows, whether or not guest users can access the teams client, and whether or not meeting room devices running teams are can display content from user accounts. The parameter descriptions below describe what settings are managed by this configuration and how they are enforced. -An organization can have only one effective Teams Client Configuration - these settings will apply across the entire organization for the particular features they control. +An organization can have only one effective Teams Client Configuration - these settings will apply across the entire organization for the particular features they control. Note that three of these settings (ContentPin, ResourceAccountContentAccess, and AllowResourceAccountSendMessage) control resource account behavior for Surface Hub devices attending Skype for Business meetings, and are not used in Microsoft Teams. @@ -106,7 +106,7 @@ Accept wildcard characters: False ### -AllowEmailIntoChannel When set to $true, mail hooks are enabled, and users can post messages to a channel by sending an email to the email address of Teams channel. -To find the email address for a channel, click the More options menu for the channel and then select Get email address. +To find the email address for a channel, click the More options menu for the channel and then select Get email address. ```yaml Type: Boolean @@ -136,7 +136,7 @@ Accept wildcard characters: False ``` ### -AllowGuestUser -Designates whether or not guest users in your organization will have access to the Teams client. If $true, guests in your tenant will be able to access the Teams client. Note that this setting has a core dependency on Guest Access being enabled in your Office 365 tenant. For more information on this topic, read Authorize Guest Access in Microsoft Teams: https://docs.microsoft.com/microsoftteams/teams-dependencies +Designates whether or not guest users in your organization will have access to the Teams client. If $true, guests in your tenant will be able to access the Teams client. Note that this setting has a core dependency on Guest Access being enabled in your Office 365 tenant. For more information on this topic, read Authorize Guest Access in Microsoft Teams: https://learn.microsoft.com/microsoftteams/teams-dependencies ```yaml Type: Boolean @@ -225,7 +225,7 @@ Accept wildcard characters: False ``` ### -AllowSkypeBusinessInterop -When set to $true, Teams conversations automatically show up in Skype for Business for users that aren't enabled for Teams. +When set to $true, Teams conversations automatically show up in Skype for Business for users that aren't enabled for Teams. ```yaml Type: Boolean @@ -349,7 +349,7 @@ Accept wildcard characters: False ``` ### -RestrictedSenderList -Senders domains can be further restricted to ensure that only allowed SMTP domains can send emails to the Teams channels. This is a comma-separated string of the domains you'd like to *allow* to send emails to Teams channels. +Senders domains can be further restricted to ensure that only allowed SMTP domains can send emails to the Teams channels. This is a semicolon-separated string of the domains you'd like to *allow* to send emails to Teams channels. ```yaml Type: String @@ -379,8 +379,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +The WhatIf switch does not work with this cmdlet. ```yaml Type: SwitchParameter @@ -395,15 +394,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md similarity index 90% rename from skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md index 2de95363ad..1e7e7f36f9 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md +++ b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md @@ -1,413 +1,415 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication -applicable: Skype for Business Online -title: Set-CsTeamsComplianceRecordingApplication -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Set-CsTeamsComplianceRecordingApplication - -## SYNOPSIS -Modifies an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] - [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] - [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] - [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] - [-Priority ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsComplianceRecordingApplication [-Tenant ] [-Instance ] - [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] - [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] - [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] - [-Priority ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Policy-based recording applications are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. - -Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. - -Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -Once the association is done, the Identity of these application instances becomes \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. -Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false -``` - -The command shown in Example 1 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is made optional for meetings. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. - -### Example 2 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeCallEstablishment $false -RequiredDuringCall $false -``` - -The command shown in Example 2 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is made optional for calls. -Please refer to the documentation of the RequiredBeforeCallEstablishment and RequiredDuringCall parameters for more information. - -### Example 3 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ConcurrentInvitationCount 2 -``` - -The command shown in Example 3 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is made resilient by specifying that two invites must be sent to the same application for the same call or meeting. -Please refer to the documentation of the ConcurrentInvitationCount parameter for more information. - -### Example 4 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') -``` - -The command shown in Example 4 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application is made resilient by pairing it with another application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. -Separate invites are sent to the paired applications for the same call or meeting. -Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. - -### Example 5 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications $null -``` - -The command shown in Example 5 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. - -In this example, the application's resiliency is removed by removing the pairing it had with the application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. -Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. - -### Example 6 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingApplication | Set-CsTeamsComplianceRecordingApplication -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false -``` - -The command shown in Example 6 modifies all existing associations between application instances of policy-based recording applications and their corresponding Teams recording policy. - -In this example, all applications are made optional for meetings. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. - -## PARAMETERS - -### -Identity -A name that uniquely identifies the application instance of the policy-based recording application. - -Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. -To do this association correctly, the Identity of these application instances must be \/\. -For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RequiredBeforeMeetingJoin -Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. - -If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. -The meeting will still continue for users who are in the meeting. - -If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredDuringMeeting -Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. - -If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. -The meeting will still continue for users who are in the meeting. - -If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredBeforeCallEstablishment -Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. - -If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredDuringCall -Indicates whether the policy-based recording application must be in the call while the call is active. - -If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. - -If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. - -In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplianceRecordingPairedApplications -Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. - -In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. -If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. - -If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. - -If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. - -If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. -Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. - -If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. - -Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. -However, you cannot do both. -Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. - -```yaml -Type: ComplianceRecordingPairedApplication[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. - -All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. -So this parameter does not affect the order of invitations to the applications, or any other routing. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication +applicable: Microsoft Teams +title: Set-CsTeamsComplianceRecordingApplication +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Set-CsTeamsComplianceRecordingApplication + +## SYNOPSIS +Modifies an existing association between an application instance of a policy-based recording application and a Teams recording policy for administering automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsComplianceRecordingApplication [-Tenant ] [-Identity ] + [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] + [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] + [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] + [-Priority ] [-Force] [-WhatIf] [-Confirm] [] +``` + +### Instance +``` +Set-CsTeamsComplianceRecordingApplication [-Tenant ] [-Instance ] + [-RequiredBeforeMeetingJoin ] [-RequiredDuringMeeting ] + [-RequiredBeforeCallEstablishment ] [-RequiredDuringCall ] + [-ConcurrentInvitationCount ] [-ComplianceRecordingPairedApplications ] + [-Priority ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Policy-based recording applications are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to enforce compliance with the administrative set policy. + +Instances of these applications are created using CsOnlineApplicationInstance cmdlets and are then associated with Teams recording policies. + +Note that application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +Once the association is done, the Identity of these application instances becomes \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. +Please also refer to the documentation of CsTeamsComplianceRecordingPolicy cmdlets for further information. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false +``` + +The command shown in Example 1 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made optional for meetings. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -RequiredBeforeCallEstablishment $false -RequiredDuringCall $false +``` + +The command shown in Example 2 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made optional for calls. +Please refer to the documentation of the RequiredBeforeCallEstablishment and RequiredDuringCall parameters for more information. + +### Example 3 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ConcurrentInvitationCount 2 +``` + +The command shown in Example 3 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by specifying that two invites must be sent to the same application for the same call or meeting. +Please refer to the documentation of the ConcurrentInvitationCount parameter for more information. + +### Example 4 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications @(New-CsTeamsComplianceRecordingPairedApplication -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +The command shown in Example 4 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application is made resilient by pairing it with another application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +Separate invites are sent to the paired applications for the same call or meeting. +Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. + +### Example 5 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingApplication -Identity 'Tag:ContosoPartnerComplianceRecordingPolicy/d93fefc7-93cc-4d44-9a5d-344b0fff2899' -ComplianceRecordingPairedApplications $null +``` + +The command shown in Example 5 modifies an existing association between an application instance of a policy-based recording application with ObjectId d93fefc7-93cc-4d44-9a5d-344b0fff2899 and a Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. + +In this example, the application's resiliency is removed by removing the pairing it had with the application instance of a policy-based recording application with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144. +Please refer to the documentation of the ComplianceRecordingPairedApplications parameter for more information. + +### Example 6 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingApplication | Set-CsTeamsComplianceRecordingApplication -RequiredBeforeMeetingJoin $false -RequiredDuringMeeting $false +``` + +The command shown in Example 6 modifies all existing associations between application instances of policy-based recording applications and their corresponding Teams recording policy. + +In this example, all applications are made optional for meetings. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredDuringMeeting parameters for more information. + +## PARAMETERS + +### -Identity +A name that uniquely identifies the application instance of the policy-based recording application. + +Application instances of policy-based recording applications must be associated with a Teams recording policy using the CsTeamsComplianceRecordingApplication cmdlets. +To do this association correctly, the Identity of these application instances must be \/\. +For example, the Identity of an application instance can be \"Tag:ContosoPartnerComplianceRecordingPolicy/39dc3ede-c80e-4f19-9153-417a65a1f144\", which indicates that the application instance with ObjectId 39dc3ede-c80e-4f19-9153-417a65a1f144 is associated with the Teams recording policy with Identity ContosoPartnerComplianceRecordingPolicy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RequiredBeforeMeetingJoin +Indicates whether the policy-based recording application must be in the meeting before the user is allowed to join the meeting. + +If this is set to True, the user will not be allowed to join the meeting if the policy-based recording application fails to join the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will be allowed to join the meeting even if the policy-based recording application fails to join the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringMeeting +Indicates whether the policy-based recording application must be in the meeting while the user is in the meeting. + +If this is set to True, the user will be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. +The meeting will still continue for users who are in the meeting. + +If this is set to False, the user will not be ejected from the meeting if the policy-based recording application leaves the meeting or is dropped from the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredBeforeCallEstablishment +Indicates whether the policy-based recording application must be in the call before the call is allowed to establish. + +If this is set to True, the call will be cancelled if the policy-based recording application fails to join the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application fails to join the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequiredDuringCall +Indicates whether the policy-based recording application must be in the call while the call is active. + +If this is set to True, the call will be cancelled if the policy-based recording application leaves the call or is dropped from the call. + +If this is set to False, call establishment will proceed normally if the policy-based recording application leaves the call or is dropped from the call. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConcurrentInvitationCount +Determines the number of invites to send out to the application instance of the policy-based recording application. Can be set to 1 or 2 only. + +In situations where application resiliency is a necessity, multiple invites can be sent to the same application for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingPairedApplications +Determines the other policy-based recording applications to pair with this application to achieve application resiliency. Can only have one paired application. + +In situations where application resiliency is a necessity, invites can be sent to separate paired applications for the same call or meeting. +If multiple such invites are accepted, then it means that multiple instances of this application are in the call or meeting and each of those instances can record independent of the others. + +If all of the invites are rejected, the application invitation process is deemed a failure and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredBeforeMeetingJoin and RequiredBeforeCallEstablishment parameters. + +If at least one of the invites is accepted and the others are rejected, the application invitation process is still deemed a success. + +If multiple invites are accepted and all of the instances leave or get dropped from the call or meeting, then the application is no longer in the call or meeting and the other flags for this application control what happens next. +Please refer to the documentation of the RequiredDuringMeeting and RequiredDuringCall parameters. + +If multiple invites are accepted and at least one of the instances remains in the call or meeting, then the application is in the call or meeting. + +Note that application resiliency can be achieved either by sending multiple invites to the same application using ConcurrentInvitationCount or by sending invites to separate paired applications using ComplianceRecordingPairedApplications. +However, you cannot do both. +Please work with your Microsoft certified policy-based recording application provider to determine if application resiliency is needed for your workflows and how best to achieve application resiliency. + +```yaml +Type: ComplianceRecordingPairedApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +This priority determines the order in which the policy-based recording applications are displayed in the output of the Get-CsTeamsComplianceRecordingPolicy cmdlet. + +All policy-based recording applications are invited in parallel to ensure low call setup and meeting join latencies. +So this parameter does not affect the order of invitations to the applications, or any other routing. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md similarity index 83% rename from skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md index 6b3d05c14a..482a4c801b 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md @@ -1,328 +1,361 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy -applicable: Skype for Business Online -title: Set-CsTeamsComplianceRecordingPolicy -schema: 2.0.0 -manager: nakumar -author: aditdalvi -ms.author: aditd -ms.reviewer: ---- - -# Set-CsTeamsComplianceRecordingPolicy - -## SYNOPSIS -Modifies an existing Teams recording policy for governing automatic policy-based recording in your tenant. -Automatic policy-based recording is only applicable to Microsoft Teams users. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] - [-Enabled ] [-WarnUserOnRemoval ] [-Description ] - [-DisableComplianceRecordingAudioNotificationForCalls ] - [-ComplianceRecordingApplications ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Instance ] - [-Enabled ] [-WarnUserOnRemoval ] [-Description ] - [-ComplianceRecordingApplications ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Teams recording policies are used in automatic policy-based recording scenarios. -When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. - -Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. -Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. -The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. -Existing calls and meetings are unaffected. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899') -``` - -The command shown in Example 1 modifies an existing per-user Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. -This policy is re-assigned a single application instance of a policy-based recording application: d93fefc7-93cc-4d44-9a5d-344b0fff2899, which is the ObjectId of the application instance as obtained from the Get-CsOnlineApplicationInstance cmdlet. - -Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by that application instance. Existing calls and meetings are unaffected. - -### Example 2 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899'), @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') -``` - -Example 2 is a variation of Example 1. -In this case, the Teams recording policy is re-assigned two application instances of policy-based recording applications. - -Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by both those application instances. Existing calls and meetings are unaffected. - -### Example 3 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $false -``` - -The command shown in Example 3 stops automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -### Example 4 -```powershell -PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true -``` - -The command shown in Example 4 causes automatic policy-based recording to occur for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -### Example 5 -```powershell -PS C:\> Get-CsTeamsComplianceRecordingPolicy | Set-CsTeamsComplianceRecordingPolicy -Enabled $false -``` - -The command shown in Example 5 stops automatic policy-based recording for all Teams recording policies. -This effectively stops automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned any Teams recording policy. Existing calls and meetings are unaffected. - -## PARAMETERS - -### -Identity -Unique identifier to be assigned to the new Teams recording policy. - -Use the "Global" Identity if you wish to assign this policy to the entire tenant. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Enabled -Controls whether this Teams recording policy is active or not. - -Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnUserOnRemoval -This parameter is reserved for future use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplianceRecordingApplications -A list of application instances of policy-based recording applications to assign to this policy. -The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. - -Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. -Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. - -```yaml -Type: ComplianceRecordingApplication[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableComplianceRecordingAudioNotificationForCalls -Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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 - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## RELATED LINKS - -[Get-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://docs.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://docs.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpairedapplication?view=skype-ps) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsComplianceRecordingPolicy +schema: 2.0.0 +manager: nakumar +author: aditdalvi +ms.author: aditd +ms.reviewer: +--- + +# Set-CsTeamsComplianceRecordingPolicy + +## SYNOPSIS +Modifies an existing Teams recording policy for governing automatic policy-based recording in your tenant. +Automatic policy-based recording is only applicable to Microsoft Teams users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Identity ] + [-Enabled ] [-WarnUserOnRemoval ] [-Description ] + [-DisableComplianceRecordingAudioNotificationForCalls ] [-RecordReroutedCalls ] + [-ComplianceRecordingApplications ] [-CustomBanner ] + [-Force] [-WhatIf] [-Confirm] [] +``` + +### Instance +``` +Set-CsTeamsComplianceRecordingPolicy [-Tenant ] [-Instance ] + [-Enabled ] [-WarnUserOnRemoval ] [-Description ] + [-ComplianceRecordingApplications ] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Teams recording policies are used in automatic policy-based recording scenarios. +When Microsoft Teams users participate in meetings or make or receive calls, the policy-based recording applications i.e. bots associated with the user's Teams recording policy are invited into the call or meeting to record audio, video and video-based screen sharing activity. + +Note that simply assigning a Teams recording policy to a Microsoft Teams user will not activate automatic policy-based recording for all Microsoft Teams calls and meetings that the user participates in. +Among other things, you will need to create an application instance of a policy-based recording application i.e. a bot in your tenant and will then need to assign an appropriate policy to the user. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +Assigning your Microsoft Teams users a Teams recording policy activates automatic policy-based recording for all new Microsoft Teams calls and meetings that the users participate in. +The system will load the recording application and join it to appropriate calls and meetings in order for it to enforce compliance with the administrative set policy. +Existing calls and meetings are unaffected. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899') +``` + +The command shown in Example 1 modifies an existing per-user Teams recording policy with the Identity ContosoPartnerComplianceRecordingPolicy. +This policy is re-assigned a single application instance of a policy-based recording application: d93fefc7-93cc-4d44-9a5d-344b0fff2899, which is the ObjectId of the application instance as obtained from the Get-CsOnlineApplicationInstance cmdlet. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by that application instance. Existing calls and meetings are unaffected. + +### Example 2 + +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id 'd93fefc7-93cc-4d44-9a5d-344b0fff2899'), @(New-CsTeamsComplianceRecordingApplication -Parent 'ContosoPartnerComplianceRecordingPolicy' -Id '39dc3ede-c80e-4f19-9153-417a65a1f144') +``` + +Example 2 is a variation of Example 1. +In this case, the Teams recording policy is re-assigned two application instances of policy-based recording applications. + +Any Microsoft Teams users who are assigned this policy will have their calls and meetings recorded by both those application instances. Existing calls and meetings are unaffected. + +### Example 3 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $false +``` + +The command shown in Example 3 stops automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +### Example 4 +```powershell +PS C:\> Set-CsTeamsComplianceRecordingPolicy -Identity 'ContosoPartnerComplianceRecordingPolicy' -Enabled $true +``` + +The command shown in Example 4 causes automatic policy-based recording to occur for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +### Example 5 +```powershell +PS C:\> Get-CsTeamsComplianceRecordingPolicy | Set-CsTeamsComplianceRecordingPolicy -Enabled $false +``` + +The command shown in Example 5 stops automatic policy-based recording for all Teams recording policies. +This effectively stops automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned any Teams recording policy. Existing calls and meetings are unaffected. + +## PARAMETERS + +### -Identity +Unique identifier to be assigned to the new Teams recording policy. + +Use the "Global" Identity if you wish to assign this policy to the entire tenant. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CustomBanner +References the Custom Banner text in the storage. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Controls whether this Teams recording policy is active or not. + +Setting this to True and having the right set of ComplianceRecordingApplications will initiate automatic policy-based recording for all new calls and meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +Setting this to False will stop automatic policy-based recording for any new calls or meetings of all Microsoft Teams users who are assigned this policy. Existing calls and meetings are unaffected. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WarnUserOnRemoval +This parameter is reserved for future use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams recording policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceRecordingApplications +A list of application instances of policy-based recording applications to assign to this policy. +The Id of each of these application instances must be the ObjectId of the application instance as obtained by the Get-CsOnlineApplicationInstance cmdlet. + +Please work with your Microsoft certified policy-based recording application provider to obtain an instance of their recording application. +Please refer to the documentation of the CsOnlineApplicationInstance cmdlets for information on how to create an application instance of a policy-based recording application. + +```yaml +Type: ComplianceRecordingApplication[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableComplianceRecordingAudioNotificationForCalls +Setting this attribute to true disables recording audio notifications for 1:1 calls that are under compliance recording. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordReroutedCalls +Setting this attribute to true enables compliance recording for calls that have been re-routed from a compliance recording-enabled user. Supported call scenarios include forward, transfer, delegation, call groups, and simultaneous ring. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose Teams recording policies are being queried. +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return your tenant ID by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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 + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingpolicy) + +[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpolicy) + +[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamscompliancerecordingpolicy) + +[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingpolicy) + +[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/get-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingapplication) + +[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/set-csteamscompliancerecordingapplication) + +[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/teams/remove-csteamscompliancerecordingapplication) + +[New-CsTeamsComplianceRecordingPairedApplication](https://learn.microsoft.com/powershell/module/teams/new-csteamscompliancerecordingpairedapplication) diff --git a/skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md similarity index 92% rename from skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md index 15975dc328..15607b6980 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsCortanaPolicy.md @@ -1,237 +1,238 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/get-csteamscortanapolicy -applicable: Skype for Business Online -title: Set-CsTeamsCortanaPolicy -schema: 2.0.0 -manager: amehta -author: akshbhat -ms.author: akshbhat -ms.reviewer: ---- - -# Set-CsTeamsCortanaPolicy - -## SYNOPSIS -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsCortanaPolicy [-Tenant ] [-Description ] [-CortanaVoiceInvocationMode ] - [-AllowCortanaVoiceInvocation ] [-AllowCortanaAmbientListening ] - [-AllowCortanaInContextSuggestions ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### Instance -``` -Set-CsTeamsCortanaPolicy [-Tenant ] [-Description ] [-CortanaVoiceInvocationMode ] - [-AllowCortanaVoiceInvocation ] [-AllowCortanaAmbientListening ] - [-AllowCortanaInContextSuggestions ] [-Instance ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - -* Disabled - Cortana voice assistant is disabled -* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation -* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -CortanaVoiceInvocationMode Disabled -``` -In this example, Cortana voice asssitant is set to disabled. - -## PARAMETERS - -### -AllowCortanaAmbientListening -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCortanaInContextSuggestions -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCortanaVoiceInvocation -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CortanaVoiceInvocationMode -The value of this field indicates if Cortana is enabled and mode of invocation. -* Disabled - Cortana voice assistant is turned off and cannot be used. -* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation -* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Provide a description of your policy to identify purpose of creating it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Identity for the policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity MyCortanaPolicy. -If you do not specify an Identity the Set-CsTeamsCortanaPolicy cmdlet will automatically modify the global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -You can return your tenant ID by running this command: -Get-CsTenant | Select-Object DisplayName, TenantID - -```yaml -Type: System.Guid -Parameter Sets: (All) -Aliases: - -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 - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamscortanapolicy +applicable: Microsoft Teams +title: Set-CsTeamsCortanaPolicy +schema: 2.0.0 +manager: amehta +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTeamsCortanaPolicy + +## SYNOPSIS +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCortanaPolicy [-Tenant ] [-Description ] [-CortanaVoiceInvocationMode ] + [-AllowCortanaVoiceInvocation ] [-AllowCortanaAmbientListening ] + [-AllowCortanaInContextSuggestions ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +### Instance +``` +Set-CsTeamsCortanaPolicy [-Tenant ] [-Description ] [-CortanaVoiceInvocationMode ] + [-AllowCortanaVoiceInvocation ] [-AllowCortanaAmbientListening ] + [-AllowCortanaInContextSuggestions ] [-Instance ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The CsTeamsCortanaPolicy cmdlets enable administrators to control settings for Cortana voice assistant in Microsoft Teams. Specifically, these specify if a user can use Cortana voice assistant in Microsoft Teams and Cortana invocation behavior via CortanaVoiceInvocationMode parameter - +* Disabled - Cortana voice assistant is disabled +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsCortanaPolicy -Identity MyCortanaPolicy -CortanaVoiceInvocationMode Disabled +``` +In this example, Cortana voice assistant is set to disabled. + +## PARAMETERS + +### -AllowCortanaAmbientListening +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaInContextSuggestions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCortanaVoiceInvocation +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CortanaVoiceInvocationMode +The value of this field indicates if Cortana is enabled and mode of invocation. +* Disabled - Cortana voice assistant is turned off and cannot be used. +* PushToTalkUserOverride - Cortana voice assistant is enabled but without wake-word ("Hey Cortana") invocation +* WakeWordPushToTalkUserOverride - Cortana voice assistant is enabled with wake-word ("Hey Cortana") invocation on devices where wake-word is supported + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of your policy to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity for the policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: -Identity MyCortanaPolicy. +If you do not specify an Identity the Set-CsTeamsCortanaPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +You can return your tenant ID by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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 + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText new file mode 100644 index 0000000000..e13c9bf900 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText @@ -0,0 +1,93 @@ +--- +Module Name: MicrosoftTeams +title: Set-CsTeamsCustomBannerText +author: saleens7 +ms.author: wblocker +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText +schema: 2.0.0 +--- + +# Set-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCustomBannerText [[-Id] ] [] +``` + +## DESCRIPTION + +Updates a single instance of a custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Set-CsTeamsCustomBannerText -Identity CustomText +``` + +Sets the properties of the CustomText instance of TeamsCustomBannerText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. You do not need to provide an ID as the backend will generate it for you. However, if you wish to provide your own ID, you can provide your own GUID. Note that you have to provide a unique ID for every CsTeamsCustomBannerText you create. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that the tenant admin would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that the tenant admin would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md new file mode 100644 index 0000000000..131dd52c2a --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md @@ -0,0 +1,93 @@ +--- +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText +title: Set-CsTeamsCustomBannerText +schema: 2.0.0 +author: saleens7 +ms.author: wblocker +--- + +# Set-CsTeamsCustomBannerText + +## SYNOPSIS + +Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsCustomBannerText [-Id ] [-Text ] [-Description ] [] +``` + +## DESCRIPTION + +Updates a single instance of custom banner text. + +## EXAMPLES + +### Example 1 +PS C:\> Set-CsTeamsCustomBannerText -Id 123e4567-e89b-12d3-a456-426614174000 -Description "Custom Banner Text Example" -Text "Custom Text" +``` + +This example sets the properties of the CustomText instance of TeamsCustomBannerText. + +## PARAMETERS + +### -Id +The Identity of the CustomBannerText. + +```yaml +Type: Guid +Parameter Sets: Identity +Aliases: +Applicable: Microsoft Teams +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Text +The text that you would like to set in the policy. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description that you would like to set to identify what this text represents. + +```yaml +Type: String +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) + +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) + +[Remove-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/remove-csteamscustombannertext) diff --git a/skype/skype-ps/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md similarity index 94% rename from skype/skype-ps/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md index 8622ba2298..3306c4828f 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEducationAssignmentsAppPolicy.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamseducationassignmentsapppolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationassignmentsapppolicy +applicable: Microsoft Teams title: Set-CsTeamsEducationAssignmentsAppPolicy schema: 2.0.0 ms.reviewer: manager: bulenteg -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsTeamsEducationAssignmentsAppPolicy @@ -212,14 +213,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md new file mode 100644 index 0000000000..2574fce8c8 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsEducationConfiguration +author: SaritaBehera +ms.author: saritabehera +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsEdcuationConfiguration + +## SYNOPSIS + +This cmdlet is used to manage the organization-wide education configuration for Teams. + +## SYNTAX + +```powershell +Set-CsTeamsEducationConfiguration + [-ParentGuardianPreferredContactMethod ] + [-UpdateParentInformation ] + [-WhatIf] + [-Confirm] + [] +``` + +## DESCRIPTION + +This cmdlet is used to manage the organization-wide education configuration for Teams which contains settings that are applicable to education organizations. + +You must be a Teams Service Administrator for your organization to run the cmdlet. + +## EXAMPLES + +### Example 1 +In this example, Email is set as the preferred contact method used for parent communication invitations across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod Email +``` + +### Example 2 +In this example, SMS is set as the preferred contact method used for parent communication invitations across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -ParentGuardianPreferredContactMethod SMS +``` + +### Example 3 +In this example, updating parents contact information is enabled by educators across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -UpdateParentInformation Enabled +``` + +### Example 4 +In this example, updating parents contact information is disabled by educators across the organization. + +```powershell +Set-CsTeamsEducationConfiguration -UpdateParentInformation Disabled +``` + +## PARAMETERS + +### -ParentGuardianPreferredContactMethod +Indicates whether Email or SMS is the preferred contact method used for parent communication invitations. Possible values are 'Email' and 'SMS'. + +```yaml +Type: String +Position: Named +Default value: Email +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateParentInformation +Indicates whether updating parents contact information is Enabled/Disabled by educators. Possible values are 'Enabled' and 'Disabled'. + +```yaml +Type: String +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsEducationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration) diff --git a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md similarity index 57% rename from skype/skype-ps/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md index 1407066fd2..f17f6774c5 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsemergencycallroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallroutingpolicy applicable: Microsoft Teams title: Set-CsTeamsEmergencyCallRoutingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: chenc schema: 2.0.0 --- @@ -29,11 +29,28 @@ This cmdlet modifies an existing Teams Emergency Call Routing Policy. Teams Emer ### Example 1 ```powershell -Set-CsTeamsEmergencyCallRoutingPolicy -Identity "testecrp" -AllowEnhancedEmergencyServices:$false -Description "test" +Set-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -AllowEnhancedEmergencyServices:$false -Description "test" ``` This example modifies an existing Teams Emergency Call Routing Policy. +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "911" -EmergencyDialMask "933" -OnlinePSTNUsage "USE911" +$en2 = New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "9112" -OnlinePSTNUsage "DKE911" +Set-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{add=$en1,$en2} +``` + +This example first creates new Teams emergency number objects and then adds these Teams emergency numbers to an existing Teams Emergency Call Routing policy. + +### Example 3 +```powershell +$en1 = New-CsTeamsEmergencyNumber -EmergencyDialString "112" -EmergencyDialMask "9112" -OnlinePSTNUsage "DKE911" +Set-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{remove=$en1} +``` + +This example first creates a new Teams emergency number object and then removes that Teams emergency number from an existing Teams Emergency Call Routing policy. + ## PARAMETERS ### -AllowEnhancedEmergencyServices @@ -67,7 +84,7 @@ Accept wildcard characters: False ``` ### -EmergencyNumbers -One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](new-csteamsemergencynumber.md) cmdlet. +One or more emergency number objects obtained from the [New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) cmdlet. ```yaml Type: Object @@ -127,7 +144,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -137,10 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +[New-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallroutingpolicy) + +[Grant-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallroutingpolicy) -[Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +[Remove-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallroutingpolicy) -[Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +[Get-CsTeamsEmergencyCallRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallroutingpolicy) -[New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) +[New-CsTeamsEmergencyNumber](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencynumber) diff --git a/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md new file mode 100644 index 0000000000..b67d6b3cd5 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md @@ -0,0 +1,233 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsEmergencyCallingPolicy +author: serdarsoysal +ms.author: serdars +manager: roykuntz +ms.reviewer: chenc +schema: 2.0.0 +--- + +# Set-CsTeamsEmergencyCallingPolicy + +## SYNOPSIS + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsEmergencyCallingPolicy [-Identity] [-ExtendedNotifications ] + [-NotificationGroup ] [-NotificationDialOutNumber ] [-ExternalLocationLookupMode ] + [-NotificationMode ] [-EnhancedEmergencyServiceDisclaimer ] + [-Description ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet modifies an existing Teams Emergency Calling policy. Emergency calling policy is used for the life cycle of emergency calling experience for the security desk and Teams client location experience. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -NotificationGroup "123@contoso.com;567@contoso.com" +``` + +This example modifies NotificationGroup of an existing policy instance with identity TestECP. + +### Example 2 +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert2@contoso.com" -NotificationMode ConferenceUnMuted +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{remove=$en1} +``` + +This example first creates a new Teams Emergency Calling Extended Notification object and then removes that Teams Emergency Calling Extended Notification from an existing Teams Emergency Calling policy. + +### Example 3 +```powershell +$en1 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "911" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode ConferenceUnMuted +$en2 = New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString "933" +Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -ExtendedNotifications @{add=$en1,$en2} +``` + +This example first creates two new Teams Emergency Calling Extended Notification objects and then adds them to an existing Teams Emergency Calling policy with identity TestECP. + +## PARAMETERS + +### -Description +Provides a description of the Teams Emergency Calling policy to identify the purpose of setting it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnhancedEmergencyServiceDisclaimer +Allows the tenant administrator to configure a text string, which is shown at the top of the Calls app. The user can acknowledge the string by selecting OK. The string will be shown on client restart. The disclaimer can be up to 350 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedNotifications +A list of one or more instances of TeamsEmergencyCallingExtendedNotification. Each TeamsEmergencyCallingExtendedNotification should use a unique EmergencyDialString. + +If an extended notification is found for an emergency phone number based on the EmergencyDialString parameter the extended notification will be controlling the notification. If no extended notification is found the notification settings on the policy instance itself will be used. + +```yaml +Type: System.Management.Automation.PSListModifier[Microsoft.Teams.Policy.Administration.Cmdlets.Core.TeamsEmergencyCallingExtendedNotification] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalLocationLookupMode +Enables ExternalLocationLookupMode. This mode allows users to set Emergency addresses for remote locations. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.ExternalLocationLookupMode +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the name of the policy + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationDialOutNumber +This parameter represents the PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values. The PSTN phone cannot be unmuted even when the NotificationMode is set to ConferenceUnMuted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationGroup +NotificationGroup is an email list of users and groups to be notified of an emergency call via Teams chat. Individual users or groups are separated by ";", for instance, "group1@contoso.com;group2@contoso.com". A maximum of 10 e-mail addresses can be specified and a maximum of 50 users in total can be notified. Both UPN and SMTP address are accepted when adding users directly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationMode +The type of conference experience for security desk notification. +Possible values are NotificationOnly, ConferenceMuted, and ConferenceUnMuted. + +```yaml +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.NotificationMode +Parameter Sets: (All) +Aliases: +Accepted values: NotificationOnly, ConferenceMuted, ConferenceUnMuted + +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) + +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) + +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) + +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) + +[New-CsTeamsEmergencyCallingExtendedNotification](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingextendednotification) diff --git a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md index 4075032123..33b326f662 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -1,10 +1,10 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy title: Set-CsTeamsEnhancedEncryptionPolicy -author: xinawang -ms.author: xinawang +author: serdarsoysal +ms.author: serdars manager: mdress schema: 2.0.0 --- @@ -17,14 +17,14 @@ Use this cmdlet to update values in existing Teams enhanced encryption policy. ## SYNTAX ``` -Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] +Set-CsTeamsEnhancedEncryptionPolicy [-Description ] [-CallingEndtoEndEncryptionEnabledType ] [-MeetingEndToEndEncryption ] [[-Identity] ] [-Force] [-Instance ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Use this cmdlet to update values in existing Teams enhanced encryption policy. -The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for End-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. +The TeamsEnhancedEncryptionPolicy enables administrators to determine which users in your organization can use the enhanced encryption settings in Teams, setting for end-to-end encryption in ad-hoc 1-to-1 VOIP calls is the parameter supported by this policy currently. ## EXAMPLES @@ -35,18 +35,27 @@ PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhanc The command shown in Example 1 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. - This policy is re-assigned CallingEndtoEndEncryptionEnabledType to be DisabledUserOverride. Any Microsoft Teams users who are assigned this policy will have their enhanced encryption policy customized such that the user can use the enhanced encryption setting in Teams. ### EXAMPLE 2 ```PowerShell -PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -MeetingEndToEndEncryption DisabledUserOverride ``` The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. +This policy has re-assigned MeetingEndToEndEncryption to be DisabledUserOverride. + +Any Microsoft Teams users who are assigned this policy and have a Teams Premium license will have the option to create end-to-end encrypted meetings. [Learn more about end-to-end encryption for Teams meetings](https://support.microsoft.com/en-us/office/use-end-to-end-encryption-for-teams-meetings-a8326d15-d187-49c4-ac99-14c17dbd617c). + +### EXAMPLE 3 +```PowerShell +PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhancedEncryptionPolicy" -Description "allow useroverride" +``` + +The command shown in Example 2 modifies an existing per-user Teams enhanced encryption policy with the Identity ContosoPartnerTeamsEnhancedEncryptionPolicy. This policy is re-assigned the description from its existing value to "allow useroverride". @@ -55,7 +64,6 @@ This policy is re-assigned the description from its existing value to "allow use ### -Description Enables administrators to provide explanatory text to accompany a Teams enhanced encryption policy. - For example, the Description might include information about the users the policy should be assigned to. ```yaml @@ -71,7 +79,22 @@ Accept wildcard characters: False ``` ### -CallingEndtoEndEncryptionEnabledType -Determines whether End-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on End-to-end encrypted calls. Set this to Disabled to prohibit. +Determines whether end-to-end encrypted calling is available for the user in Teams. Set this to DisabledUserOverride to allow user to turn on end-to-end encrypted calls. Set this to Disabled to prohibit. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingEndToEndEncryption +Determines whether end-to-end encrypted meetings are available in Teams ([requires a Teams Premium license](https://www.microsoft.com/en-us/microsoft-teams/premium)). Set this to DisabledUserOverride to allow users to schedule end-to-end encrypted meetings. Set this to Disabled to prohibit. ```yaml Type: Enum @@ -88,7 +111,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams enhanced encryption policy. - Use the "Global" Identity if you wish modify the policy set for the entire tenant. ```yaml @@ -173,14 +195,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) -[New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) -[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +[Remove-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsenhancedencryptionpolicy) -[Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +[Grant-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsenhancedencryptionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md new file mode 100644 index 0000000000..bf14cb6cb1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md @@ -0,0 +1,453 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseventspolicy +title: Set-CsTeamsEventsPolicy +schema: 2.0.0 +ms.date: 04/23/2025 +--- + +# Set-CsTeamsEventsPolicy + +## SYNOPSIS +This cmdlet allows you to configure options for customizing Teams events experiences. Note that this policy is currently still in preview. + +## SYNTAX + +``` +Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] + [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] + [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] + [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] + [-RecordingForTownhall ] [-RecordingForWebinar ] + [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] + [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] +``` + +## DESCRIPTION +User-level policy for tenant admin to configure options for customizing Teams events experiences. Use this cmdlet to update an existing policy. + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +``` + +The command shown in Example 1 sets the value of the Default (Global) Events Policy in the organization to disable webinars, and leaves all other parameters the same. + +## PARAMETERS + +### -AllowWebinars +This setting governs if a user can create webinars using Teams Events. +Possible values are: + - **Enabled**: Enables creating webinars. + - **Disabled**: Disables creating webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseMicrosoftECDN +This setting governs whether the admin disables this property and prevents the organizers from creating town halls that use Microsoft eCDN even though they have been assigned a Teams Premium license. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTownhalls +This setting governs if a user can create town halls using Teams Events. +Possible values are: + - **Enabled**: Enables creating town halls. + - **Disabled**: Disables creating town halls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallEventAttendeeAccess +This setting governs what identity types may attend a Town hall that is scheduled by a particular person or group that is assigned this policy. +Possible values are: + - **Everyone**: Anyone with the join link may enter the event. + - **EveryoneInOrganizationAndGuests**: Only those who are Guests to the tenant, MTO users, and internal AAD users may enter the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEmailEditing +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. +Possible values are: + - **Enabled**: Enables editing of communication emails. + - **Disabled**: Disables editing of communication emails. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text to accompany a Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventAccessType + +> [!NOTE] +> Currently, webinar and town hall event access is managed together via EventAccessType. + +This setting governs which users can access the event registration page or the event site to register. It also governs which user type is allowed to join the session/s in the event. +Possible values are: + - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. + - **EveryoneInCompanyExcludingGuests**: Enables creating events to allow only in-tenant users to register and join the event. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Unique identifier assigned to the Teams Events policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. + +Possible values are: +DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTownhallTypesForRecordingPublish +This setting describes how IT admins can control which types of Town Hall attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedWebinarTypesForRecordingPublish +This setting describes how IT admins can control which types of webinar attendees can have their recordings published. + +Possible values are: +None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEventIntegrations +This setting governs access to the integrations tab in the event creation workflow. + +Possible values +true, false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TownhallChatExperience +This setting governs whether the user can enable the Comment Stream chat experience for Town Halls. + +Possible values are: Optimized, None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForTownhall +Determines whether recording is allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow recording in user's townhalls. + - **Disabled**: Prohibit recording in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingForWebinar +Determines whether recording is allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow recording in user's webinars. + - **Disabled**: Prohibit recording in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForTownhall +Determines whether transcriptions are allowed in a user's townhall. + +Possible values are: + - **Enabled**: Allow transcriptions in user's townhalls. + - **Disabled**: Prohibit transcriptions in user's townhalls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TranscriptionForWebinar +Determines whether transcriptions are allowed in a user's webinar. + +Possible values are: + - **Enabled**: Allow transcriptions in user's webinars. + - **Disabled**: Prohibit transcriptions in user's webinars. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BroadcastPremiumApps +This setting will enable Tenant Admins to specify if an organizer of a Teams Premium town hall may add an app that is accessible by everyone, including attendees, in a broadcast style Event including a Town hall. This does not include control over apps (such as AI Producer and Custom Streaming Apps) that are only accessible by the Event group. + +Possible values are: +- **Enabled**: An organizer of a Premium town hall can add a Premium App such as Polls to the Town hall +- **Disabled**: An organizer of a Premium town hall CANNOT add a Premium App such as Polls to the Town hall + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch does not work with this 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 +The WhatIf switch does not work with this cmdlet. +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md new file mode 100644 index 0000000000..3538e2a0af --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsExternalAccessConfiguration.md @@ -0,0 +1,129 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsexternalaccessconfiguration +title: Set-CsTeamsExternalAccessConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsExternalAccessConfiguration + +## SYNOPSIS + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsExternalAccessConfiguration [-BlockedUsers ] [-BlockExternalUserAccess ] [[-Identity] ] [-Force] [-WhatIf] [] +``` + +## DESCRIPTION +Allows admins to set values in the TeamsExternalAccessConfiguration, which specifies configs that can be used to improve entire org security. This configuration primarily allows admins to block malicious external users from the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsExternalAccessConfiguration -Identity Global -BlockExternalAccessUserAccess $true +``` + +In this example, the admin has enabled the BlockExternalUserAccess. The users in the BlockedUsers will be blocked from communicating with the internal users. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsExternalAccessConfiguration -Identity Global -BlockedUsers @("user1@malicious.com", "user2@malicious.com") +``` + +In this example, the admin has added two malicious users into the blocked list. These blocked users can't communicate with internal users anymore. + +## PARAMETERS + +### -BlockExternalAccessUserAccess +Designates whether BlockedUsers list is taking effect or not. $true means BlockedUsers are blocked and can't communicate with internal users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedUsers +You can specify blocked users using a List object that contains either the user email or the MRI from the external user you want to block. The user in the list will not able to communicate with the internal users in your organization. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Bypass confirmation + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The only option is Global + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsFeedbackPolicy.md b/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md similarity index 78% rename from skype/skype-ps/skype/Set-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md index 812585ebd3..c6a1f2b39c 100644 --- a/skype/skype-ps/skype/Set-CsTeamsFeedbackPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsFeedbackPolicy.md @@ -1,13 +1,9 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsfeedbackpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfeedbackpolicy +applicable: Microsoft Teams title: Set-CsTeamsFeedbackPolicy schema: 2.0.0 -manager: bulenteg -ms.author: tomkau -author: tomkau -ms.reviewer: --- # Set-CsTeamsFeedbackPolicy @@ -19,10 +15,19 @@ Use this cmdlet to modify a Teams feedback policy (the ability to send feedback ## SYNTAX ``` -Set-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] - [-ReceiveSurveysMode ] [-UserInitiatedMode ] [-AllowEmailCollection ] - [-AllowLogCollection ] [-AllowScreenshotCollection ] - [-Force] [-Instance ] +Set-CsTeamsFeedbackPolicy [[-Identity] ] + [-AllowEmailCollection ] + [-AllowLogCollection ] + [-AllowScreenshotCollection ] + [-Confirm] + [-EnableFeatureSuggestions ] + [-Force] + [-Instance ] + [-ReceiveSurveysMode ] + [-Tenant ] + [-UserInitiatedMode ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -39,28 +44,28 @@ In this example, the policy "New Hire Feedback Policy" is modified, sets the use ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +The unique identifier of the policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -69,16 +74,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The unique identifier of the policy. +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -200,6 +205,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableFeatureSuggestions +This setting will enable Tenant Admins to hide or show the Teams menu item "Help | Suggest a Feature". +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +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. @@ -216,6 +237,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Management.Automation.PSObject @@ -223,6 +247,7 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md b/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md new file mode 100644 index 0000000000..1a28cf4317 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsFilesPolicy.md @@ -0,0 +1,188 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsfilespolicy +title: Set-CsTeamsFilesPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsFilesPolicy + +## SYNOPSIS +Creates a new teams files policy. + Teams files policies determine whether or not files entry points to SharePoint enabled for a user. +The policies also specify third-party app ID to allow file storage (e.g., Box). + +## SYNTAX + +```powershell +Set-CsTeamsFilesPolicy [-NativeFileEntryPoints ] [-SPChannelFilesTab ] + [-DefaultFileUploadAppId ] [-FileSharingInChatswithExternalUsers ] [-Identity] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +If your organization chooses a third-party for content storage, you can turn off the NativeFileEntryPoints parameter in the Teams Files policy. This parameter is enabled by default, which shows option to attach OneDrive / SharePoint content from Teams chats or channels. When this parameter is disabled, users won't see access points for OneDrive and SharePoint in Teams. Please note that OneDrive app in the left navigation pane in Teams isn't affected by this policy. +Teams administrators can also choose which file service will be used by default when users upload files from their local devices by dragging and dropping them in a chat or channel. OneDrive and SharePoint are the existing defaults, but admins can now change it to a third-party app. +Teams administrators would be able to create a customized teams files policy to match the organization's requirements. + +## EXAMPLES + +### Example 1 +``` +Set-CsTeamsFilesPolicy -Identity "CustomOnlineVoicemailPolicy" -NativeFileEntryPoints Disabled/Enabled +``` + +The command shown in Example 1 changes the teams files policy CustomTeamsFilesPolicy with NativeFileEntryPoints set to Disabled/Enabled. + +### Example 2 +``` +Set-CsTeamsFilesPolicy -DefaultFileUploadAppId GUID_appId +``` + +The command shown in Example 2 changes the DefaultFileUploadAppId to AppId_GUID for tenant level global teams files policy when calling without Identity parameter. + +## PARAMETERS + +### -Identity +A unique identifier specifying the scope, and in some cases the name, of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NativeFileEntryPoints +This parameter is enabled by default, which shows the option to upload content from ODSP to Teams chats or channels. . +Possible values are Enabled or Disabled. +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False + +``` +### -DefaultFileUploadAppId +This can be used by the 3p apps to configure their app, so when the files will be dragged and dropped in compose, it will get uploaded in that 3P app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileSharingInChatswithExternalUsers + +Indicates if file sharing in chats with external users is enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SPChannelFilesTab + +Indicates whether Iframe channel files tab is enabled, if not, integrated channel files tab will be enabled. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsfilespolicy) + +[Get-CsTeamsFilesPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsfilespolicy) + diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestCallingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsTeamsGuestCallingConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md index 9f4314a015..f79231986e 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestCallingConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsGuestCallingConfiguration.md @@ -1,21 +1,20 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsguestcallingconfiguration -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestcallingconfiguration +applicable: Microsoft Teams title: Set-CsTeamsGuestCallingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsGuestCallingConfiguration ## SYNOPSIS Allows admins to set values in the GuestCallingConfiguration, which specifies what options guest users have for calling within Teams. - ## SYNTAX ### Identity (Default) @@ -105,7 +104,7 @@ Accept wildcard characters: False ``` ### -Instance -Internal Microsoft use +Internal Microsoft use ```yaml Type: PSObject @@ -151,8 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,6 +158,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMeetingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md similarity index 81% rename from skype/skype-ps/skype/Set-CsTeamsGuestMeetingConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md index 45725ec8e1..1c4ee27ee2 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMeetingConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsGuestMeetingConfiguration.md @@ -1,14 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsguestmeetingconfiguration -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmeetingconfiguration +applicable: Microsoft Teams title: Set-CsTeamsGuestMeetingConfiguration schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Set-CsTeamsGuestMeetingConfiguration @@ -20,16 +16,16 @@ Designates what meeting features guests using Microsoft Teams will have availabl ## SYNTAX ### Identity (Default) -``` +```powershell Set-CsTeamsGuestMeetingConfiguration [-Tenant ] [-AllowIPVideo ] - [-ScreenSharingMode ] [-AllowMeetNow ] [-LiveCaptionsEnabledType ] [[-Identity] ] [-Force] [-WhatIf] + [-ScreenSharingMode ] [-AllowMeetNow ] [-AllowTranscription ] [-LiveCaptionsEnabledType ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance -``` +```powershell Set-CsTeamsGuestMeetingConfiguration [-Tenant ] [-AllowIPVideo ] - [-ScreenSharingMode ] [-AllowMeetNow ] [-LiveCaptionsEnabledType ] [-Instance ] [-Force] [-WhatIf] [-Confirm] + [-ScreenSharingMode ] [-AllowMeetNow ] [-AllowTranscription ] [-LiveCaptionsEnabledType ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -64,8 +60,7 @@ Accept wildcard characters: False ``` ### -AllowMeetNow -Determines whether guests can start ad-hoc meetings. Set this to TRUE to allow guests to start ad-hoc meetings. Set this to FALSE to prohibit guests from starting ad-hoc meetings. - +Determines whether guests can start ad-hoc meetings. Set this to TRUE to allow guests to start ad-hoc meetings. Set this to FALSE to prohibit guests from starting ad-hoc meetings. ```yaml Type: Boolean @@ -200,9 +195,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowTranscription +Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -210,6 +219,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md similarity index 71% rename from skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md index 045521764c..41682046d1 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsguestmessagingconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsguestmessagingconfiguration +applicable: Microsoft Teams title: Set-CsTeamsGuestMessagingConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsGuestMessagingConfiguration @@ -21,7 +21,7 @@ TeamsGuestMessagingConfiguration determines the messaging settings for the guest ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] - [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [[-Identity] ] + [-AllowUserDeleteChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-UsersCanDeleteBotMessages ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -29,7 +29,7 @@ Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage < ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] - [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-Instance ] [-Force] + [-AllowUserDeleteChat ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-UsersCanDeleteBotMessages ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -63,7 +63,7 @@ Accept wildcard characters: False ``` ### -AllowMemes -Determines if memes are available for use. +Determines if memes are available for use. ```yaml Type: Boolean @@ -93,7 +93,7 @@ Accept wildcard characters: False ``` ### -AllowUserChat -Determines if a user is allowed to chat. +Determines if a user is allowed to chat. ```yaml Type: Boolean @@ -123,7 +123,7 @@ Accept wildcard characters: False ``` ### -AllowUserEditMessage -Determines if a user is allowed to edit their own messages. +Determines if a user is allowed to edit their own messages. ```yaml Type: Boolean @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UsersCanDeleteBotMessages +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -166,6 +181,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their one-on-one chat, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GiphyRatingType Determines Giphy content restrictions. Default value is "Moderate", other options are "NoRestriction" and "Strict" @@ -254,11 +284,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Management.Automation.PSObject - ## OUTPUTS ### System.Object @@ -266,4 +298,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Set-CsTeamsIPPhonePolicy.md b/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md similarity index 82% rename from skype/skype-ps/skype/Set-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md index ff0423a10c..0f608fbf29 100644 --- a/skype/skype-ps/skype/Set-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsIPPhonePolicy.md @@ -1,246 +1,259 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsipphonepolicy -applicable: Skype for Business Online -title: Set-CsTeamsIPPhonePolicy -author: tonywoodruff -ms.author: anwoodru -ms.reviewer: kponnus -manager: sandrao -schema: 2.0.0 ---- - -# Set-CsTeamsIPPhonePolicy - -## SYNOPSIS - -Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings. - -## SYNTAX - -``` -Set-CsTeamsIPPhonePolicy [-Description ] [-HotDeskingIdleTimeoutInMinutes ] - [-SearchOnCommonAreaPhoneMode ] [-AllowHotDesking ] [-AllowHomeScreen ] [-AllowBetterTogether ] [[-Identity] ] [-Tenant ] - [-SignInMode ] [-WhatIf] [-Confirm] [-Force] [-Instance ] -``` - -## DESCRIPTION - -Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing TeamsIPPhonePolicy. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin -``` -This example shows the SignInMode "CommonAreaPhoneSignIn" being set against the policy named "CommonAreaPhone". - -## PARAMETERS - -### -AllowBetterTogether -Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. -Possible values this parameter can take: - -- Enabled -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowHomeScreen -Determines whether the Home Screen feature of the Teams IP Phones is enabled. -Possible values this parameter can take: - -- Enabled -- EnabledUserOverride -- Disabled - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: EnabledUserOverride -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -AllowHotDesking -Determines if the hot desking feature is enabled or not. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Free form text that can be used by administrators as desired. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HotDeskingIdleTimeoutInMinutes -Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out. - -```yaml -Type: Int -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The identity of the policy. To specify the global policy for the organization, use "global". To specify any other policy provide the name of that policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchOnCommonAreaPhoneMode -Determines whether a user can look up contacts from the tenant's global address book when the phone is signed into the Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInMode -Determines the sign in mode for the device when signing in to Teams. -Possible Values: -- 'UserSignIn: Enables the individual user's Teams experience on the phone' -- 'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone' -- 'MeetingSignIn: Enables the meeting/conference room experience on the phone' - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Internal Microsoft use only. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 -``` - -## INPUTS - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsipphonepolicy +applicable: Microsoft Teams +title: Set-CsTeamsIPPhonePolicy +author: tonywoodruff +ms.author: anwoodru +ms.reviewer: kponnus +manager: sandrao +schema: 2.0.0 +--- + +# Set-CsTeamsIPPhonePolicy + +## SYNOPSIS + +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings. + +## SYNTAX + +``` +Set-CsTeamsIPPhonePolicy [[-Identity] ] + [-AllowBetterTogether ] + [-AllowHomeScreen ] + [-AllowHotDesking ] + [-Confirm] + [-Description ] + [-Force] + [-HotDeskingIdleTimeoutInMinutes ] + [-Instance ] + [-SearchOnCommonAreaPhoneMode ] + [-SignInMode ] + [-Tenant ] + [-WhatIf] + [] +``` + +## DESCRIPTION + +Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing TeamsIPPhonePolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin +``` +This example shows the SignInMode "CommonAreaPhoneSignIn" being set against the policy named "CommonAreaPhone". + +## PARAMETERS + +### -AllowBetterTogether +Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. +Possible values this parameter can take: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHomeScreen +Determines whether the Home Screen feature of the Teams IP Phones is enabled. +Possible values this parameter can take: + +- Enabled +- EnabledUserOverride +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowHotDesking +Determines if the hot desking feature is enabled or not. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Free form text that can be used by administrators as desired. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HotDeskingIdleTimeoutInMinutes +Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out. + +```yaml +Type: Int +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy. To specify the global policy for the organization, use "global". To specify any other policy provide the name of that policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SearchOnCommonAreaPhoneMode +Determines whether a user can look up contacts from the tenant's global address book when the phone is signed into the Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignInMode +Determines the sign in mode for the device when signing in to Teams. +Possible Values: +- 'UserSignIn: Enables the individual user's Teams experience on the phone' +- 'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone' +- 'MeetingSignIn: Enables the meeting/conference room experience on the phone' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md new file mode 100644 index 0000000000..7bb81a371f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMediaConnectivityPolicy.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsMediaConnectivityPolicy +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMediaConnectivityPolicy +schema: 2.0.0 +author: lirunping-MSFT +ms.author: runli +--- + +# Set-CsTeamsMediaConnectivityPolicy + +## SYNOPSIS + +This cmdlet Set Teams media connectivity policy value for current tenant. + +## SYNTAX + +``` +Set-CsTeamsMediaConnectivityPolicy -Identity -DirectConnection [] +``` + +## DESCRIPTION + +This cmdlet Set Teams media connectivity policy DirectConnection value for current tenant. The value can be "Enabled" or "Disabled" + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsMediaConnectivityPolicy -Identity Test -DirectConnection Disabled + +Identity DirectConnection +-------- ---------------- +Global Enabled +Tag:Test Disabled +``` + +Set Teams media connectivity policy "DirectConnection" value to "Disabled" for identity "Test". + +## PARAMETERS + +### -Identity +Identity of the Teams media connectivity policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DirectConnection +Policy value of the Teams media connectivity DirectConnection policy. + +```yaml +Type: Boolean +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +[New-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmediaconnectivitypolicy) + +[Remove-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmediaconnectivitypolicy) + +[Get-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmediaconnectivitypolicy) + +[Grant-CsTeamsMediaConnectivityPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmediaconnectivitypolicy) \ No newline at end of file diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md new file mode 100644 index 0000000000..033a024718 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md @@ -0,0 +1,208 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy +schema: 2.0.0 +title: Set-CsTeamsMeetingBrandingPolicy +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: stanlythomas +applicable: Microsoft Teams +--- + +# Set-CsTeamsMeetingBrandingPolicy + +## SYNOPSIS +The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. + +## SYNTAX + +``` +Set-CsTeamsMeetingBrandingPolicy + [-MeetingBackgroundImages ] + [-MeetingBrandingThemes ] + [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] + [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The `Set-CsTeamsMeetingBrandingPolicy` cmdlet allows administrators to update existing meeting branding policies. +However, it cannot be used to upload the images. If you want to upload the images, you should use Teams Admin Center. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsMeetingBrandingPolicy +PS C:\> $brandingPolicy = Get-CsTeamsMeetingBrandingPolicy -Identity "demo branding" +PS C:\> $brandingPolicy.MeetingBrandingThemes[0].BrandAccentColor = "#FF0000" +PS C:\> Set-CsTeamsMeetingBrandingPolicy -Identity "demo branding" -MeetingBrandingThemes $brandingPolicy.MeetingBrandingThemes +``` + +In this example, the commands will change the brand accent color of the theme inside the `demo branding` meeting branding policy to `#FF0000` + +## PARAMETERS + +### -DefaultTheme +*This parameter is reserved for Microsoft internal use only.* +Identity of default meeting theme. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingBackgroundImages +Enables custom meeting backgrounds. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableMeetingOptionsThemeOverride +Allows organizers to control meeting themes. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Identity of meeting branding policy that will be updated. To refer to the global policy, use this syntax: `-Identity global`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBackgroundImages +*This parameter is reserved for Microsoft internal use only.* +List of meeting background images. +It is not possible to add or remove background images using cmdlets. You should use Teams Admin Center for that purpose. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingBrandingThemes +List of meeting branding themes. You can alter the list returned by the `Get-CsTeamsMeetingBrandingPolicy` cmdlet and pass it to this parameter. +It is not possible to add or remove meeting branding themes using cmdlets. You should use Teams Admin Center for that purpose. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +Available in Teams PowerShell Module 4.9.3 and later. + +## RELATED LINKS + +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) + +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) + +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) + +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) + +[Set-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md index 8818a75e6c..a369ef43c1 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastConfiguration.md @@ -1,16 +1,15 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsmeetingbroadcastconfiguration -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastconfiguration +applicable: Microsoft Teams title: Set-CsTeamsMeetingBroadcastConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- - # Set-CsTeamsMeetingBroadcastConfiguration ## SYNOPSIS @@ -46,7 +45,7 @@ Tenant level configuration for broadcast events in Teams ## PARAMETERS ### -AllowSdnProviderForBroadcastMeeting -If set to $true, Teams meeting broadcast streams are enabled to take advantage of the network and bandwidth management capabilities of your Software Defined Network (SDN) provider. +If set to $true, Teams meeting broadcast streams are enabled to take advantage of the network and bandwidth management capabilities of your Software Defined Network (SDN) provider. ```yaml Type: Boolean @@ -121,7 +120,7 @@ Accept wildcard characters: False ``` ### -SdnApiTemplateUrl -Specifies the Software Defined Network (SDN) provider's HTTP API endpoint. This information is provided to you by the SDN provider. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. +Specifies the Software Defined Network (SDN) provider's HTTP API endpoint. This information is provided to you by the SDN provider. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. ```yaml Type: String @@ -136,7 +135,7 @@ Accept wildcard characters: False ``` ### -SdnApiToken -Specifies the Software Defined Network (SDN) provider's authentication token which is required to use their SDN license. This is required by some SDN providers who will give you the required token. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. +Specifies the Software Defined Network (SDN) provider's authentication token which is required to use their SDN license. This is required by some SDN providers who will give you the required token. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. ```yaml Type: String @@ -151,7 +150,7 @@ Accept wildcard characters: False ``` ### -SdnLicenseId -Specifies the Software Defined Network (SDN) license identifier. This is required and provided by some SDN providers. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. +Specifies the Software Defined Network (SDN) license identifier. This is required and provided by some SDN providers. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. ```yaml Type: String @@ -166,7 +165,22 @@ Accept wildcard characters: False ``` ### -SdnProviderName -Specifies the Software Defined Network (SDN) provider's name. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. +Specifies the Software Defined Network (SDN) provider's name. This parameter is only required if AllowSdnProviderForBroadcastMeeting is set to $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SdnRuntimeConfiguration +Specifies connection parameters used to connect with a 3rd party eCDN provider. These parameters should be obtained from the SDN provider to be used. ```yaml Type: String @@ -181,7 +195,7 @@ Accept wildcard characters: False ``` ### -SupportURL -Specifies a URL where broadcast event attendees can find support information or FAQs specific to that event. The URL will be displayed to the attendees during the broadcast. +Specifies a URL where broadcast event attendees can find support information or FAQs specific to that event. The URL will be displayed to the attendees during the broadcast. ```yaml Type: String @@ -227,8 +241,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -236,6 +249,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md similarity index 94% rename from skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md index f7326a8616..5fda5b675c 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBroadcastPolicy.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsmeetingbroadcastpolicy -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbroadcastpolicy +applicable: Microsoft Teams title: Set-CsTeamsMeetingBroadcastPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsMeetingBroadcastPolicy @@ -40,13 +40,12 @@ Set-CsTeamsMeetingBroadcastPolicy [-Tenant ] [-Description ] User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. Use this cmdlet to update an existing policy. - ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-CsTeamsMeetingBroadcastPolicy -Identity Global -AllowBroadcastScheduling $false +PS C:\> Set-CsTeamsMeetingBroadcastPolicy -Identity Global -AllowBroadcastScheduling $false ``` Sets the value of the Default (Global) Broadcast Policy in the organization to disable broadcast scheduling, and leaves all other parameters the same. @@ -55,7 +54,7 @@ Sets the value of the Default (Global) Broadcast Policy in the organization to d ### -AllowBroadcastScheduling -Specifies whether this user can create broadcast events in Teams. This setting impacts broadcasts that use both self-service and external encoder production methods. +Specifies whether this user can create broadcast events in Teams. This setting impacts broadcasts that use both self-service and external encoder production methods. ```yaml Type: Boolean @@ -96,7 +95,7 @@ Specifies the attendee visibility mode of the broadcast events created by this u > This setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. Possible values: -- Everyone +- Everyone - EveryoneInCompany - InvitedUsersInCompany - EveryoneInCompanyAndExternal @@ -255,8 +254,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsTeamsMeetingConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md index 099c3e7852..10cd0d63f9 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingConfiguration.md @@ -1,14 +1,10 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsmeetingconfiguration -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingconfiguration +applicable: Microsoft Teams title: Set-CsTeamsMeetingConfiguration schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Set-CsTeamsMeetingConfiguration @@ -21,23 +17,23 @@ The CsTeamsMeetingConfiguration cmdlets enable administrators to control the mee ### Identity (Default) -``` +```powershell Set-CsTeamsMeetingConfiguration [-Tenant ] [-LogoURL ] [-LegalURL ] [-HelpURL ] [-CustomFooterText ] [-DisableAnonymousJoin ] [-EnableQoS ] [-ClientAudioPort ] [-ClientAudioPortRange ] [-ClientVideoPort ] [-ClientVideoPortRange ] [-ClientAppSharingPort ] [-ClientAppSharingPortRange ] - [-ClientMediaPortRangeEnabled ] [-DisableAppInteractionForAnonymousUsers ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] + [-ClientMediaPortRangeEnabled ] [-DisableAppInteractionForAnonymousUsers ] [[-Identity] ] [-FeedbackSurveyForAnonymousUsers ] [-LimitPresenterRolePermissions ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance -``` +```powershell Set-CsTeamsMeetingConfiguration [-Tenant ] [-LogoURL ] [-LegalURL ] [-HelpURL ] [-CustomFooterText ] [-DisableAnonymousJoin ] [-EnableQoS ] [-ClientAudioPort ] [-ClientAudioPortRange ] [-ClientVideoPort ] [-ClientVideoPortRange ] [-ClientAppSharingPort ] [-ClientAppSharingPortRange ] - [-ClientMediaPortRangeEnabled ] [-DisableAppInteractionForAnonymousUsers ] [-Instance ] [-Force] [-WhatIf] [-Confirm] + [-ClientMediaPortRangeEnabled ] [-DisableAppInteractionForAnonymousUsers ] [-FeedbackSurveyForAnonymousUsers ] [-LimitPresenterRolePermissions ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -370,6 +366,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FeedbackSurveyForAnonymousUsers +Determines if anonymous participants receive surveys to provide feedback about their meeting experience. Set to Disabled to disable anonymous meeting participants to receive surveys. Set to Enabled to allow anonymous meeting participants to receive surveys. +Possible values: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LimitPresenterRolePermissions +When set to True, users within the Tenant will have their presenter role capabilities limited. +When set to False, the presenter role capabilities will not be impacted and will remain as is. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +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. @@ -388,8 +419,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md new file mode 100644 index 0000000000..5adc506782 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md @@ -0,0 +1,2031 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingpolicy +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsMeetingPolicy +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: alejandramu +ms.date: 2/26/2025 +--- + +# Set-CsTeamsMeetingPolicy + +## SYNOPSIS +The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +## SYNTAX + +### Identity (Default) + +```powershell +Set-CsTeamsMeetingPolicy [[-Identity] ] + [-AIInterpreter ] + [-AllowAnnotations ] + [-AllowAnonymousUsersToDialOut ] + [-AllowAnonymousUsersToJoinMeeting ] + [-AllowAnonymousUsersToStartMeeting ] + [-AllowAvatarsInGallery ] + [-AllowBreakoutRooms ] + [-AllowCarbonSummary ] + [-AllowCartCaptionsScheduling ] + [-AllowChannelMeetingScheduling ] + [-AllowCloudRecording ] + [-AllowDocumentCollaboration ] + [-AllowEngagementReport ] + [-AllowExternalNonTrustedMeetingChat ] + [-AllowExternalParticipantGiveRequestControl ] + [-AllowImmersiveView ] + [-AllowIPAudio ] + [-AllowIPVideo ] + [-AllowLocalRecording ] + [-AllowMeetingCoach ] + [-AllowMeetNow ] + [-AllowMeetingReactions ] + [-AllowMeetingRegistration ] + [-AllowNDIStreaming ] + [-AllowNetworkConfigurationSettingsLookup ] + [-AllowOrganizersToOverrideLobbySettings ] + [-AllowOutlookAddIn ] + [-AllowPSTNUsersToBypassLobby ] + [-AllowParticipantGiveRequestControl ] + [-AllowPowerPointSharing ] + [-AllowPrivateMeetNow ] + [-AllowPrivateMeetingScheduling ] + [-AllowRecordingStorageOutsideRegion ] + [-AllowScreenContentDigitization ] + [-AllowSharedNotes ] + [-AllowTasksFromTranscript ] + [-AllowTrackingInReport ] + [-AllowTranscription ] + [-AllowedUsersForMeetingContext ] + [-AllowUserToJoinExternalMeeting ] + [-AllowWatermarkCustomizationForCameraVideo ] + [-AllowWatermarkCustomizationForScreenSharing ] + [-AllowWatermarkForCameraVideo ] + [-AllowWatermarkForScreenSharing ] + [-AllowWhiteboard ] + [-AllowedStreamingMediaInput ] + [-AnonymousUserAuthenticationMethod ] + [-AttendeeIdentityMasking ] + [-AudibleRecordingNotification ] + [-AutoAdmittedUsers ] + [-AutoRecording ] + [-AutomaticallyStartCopilot ] + [-BlockedAnonymousJoinClientTypes ] + [-CaptchaVerificationForMeetingJoin ] + [-ChannelRecordingDownload ] + [-Confirm] + [-ConnectToMeetingControls ] + [-ContentSharingInExternalMeetings ] + [-Copilot ] + [-CopyRestriction ] + [-Description ] + [-DesignatedPresenterRoleMode ] + [-DetectSensitiveContentDuringScreenSharing ] + [-EnrollUserOverride ] + [-ExplicitRecordingConsent ] + [-ExternalMeetingJoin ] + [-Force] + [-InfoShownInReportMode ] + [-IPAudioMode ] + [-IPVideoMode ] + [-LiveCaptionsEnabledType ] + [-LiveInterpretationEnabledType ] + [-LiveStreamingMode ] + [-LobbyChat ] + [-MediaBitRateKb ] + [-MeetingChatEnabledType ] + [-MeetingInviteLanguages ] + [-NewMeetingRecordingExpirationDays ] + [-NoiseSuppressionForDialInParticipants ] + [-ParticipantNameChange ] + [-PreferredMeetingProviderForIslandsMode ] + [-QnAEngagementMode ] + [-RecordingStorageMode ] + [-RoomAttributeUserOverride ] + [-RoomPeopleNameUserOverride ] + [-ScreenSharingMode ] + [-SmsNotifications ] + [-SpeakerAttributionMode ] + [-StreamingAttendeeMode ] + [-TeamsCameraFarEndPTZMode ] + [-Tenant ] + [-UsersCanAdmitFromLobby ] + [-VideoFiltersMode ] + [-VoiceIsolation ] + [-VoiceSimulationInInterpreter ] + [-WatermarkForAnonymousUsers ] + [-WatermarkForCameraVideoOpacity ] + [-WatermarkForCameraVideoPattern ] + [-WatermarkForScreenSharingOpacity ] + [-WatermarkForScreenSharingPattern ] + [-AllowedUsersForMeetingDetails ] + [-RealTimeText ] + [-WhatIf] + [-WhoCanRegister ] + [] +``` + +## DESCRIPTION + +The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting. It also helps determine how meetings deal with anonymous or external users. + +The Set-CsTeamsMeetingPolicy cmdlet allows administrators to update existing meeting policies that can be assigned to particular users to control Teams features related to meetings. + +## EXAMPLES + +### EXAMPLE 1 +```powershell +Set-CsTeamsMeetingPolicy -Identity SalesMeetingPolicy -AllowTranscription $True +``` + +The command shown in Example 1 uses the Set-CsTeamsMeetingPolicy cmdlet to update an existing meeting policy with the Identity SalesMeetingPolicy. +This policy will use all the existing values except one: AllowTranscription; in this example, meetings for users with this policy can include real time or post meeting captions and transcriptions. + +### EXAMPLE 2 + +```powershell +Set-CsTeamsMeetingPolicy -Identity HrMeetingPolicy -AutoAdmittedUsers "Everyone" -AllowMeetNow $False +``` + +In Example 2, the Set-CsTeamsMeetingPolicy cmdlet is used to update a meeting policy with the Identity HrMeetingPolicy. +In this example two different property values are configured: AutoAdmittedUsers is set to Everyone and AllowMeetNow is set to False. +All other policy properties will use the existing values. + +### EXAMPLE 3 + +```powershell +Set-CsTeamsMeetingPolicy -Identity NonEVNetworkRoamingPolicy -AllowNetworkConfigurationSettingsLookup $True +``` + +In Example 3, the Set-CsTeamsMeetingPolicy cmdlet is used to update an existing meeting policy with the Identity NonEVNetworkRoamingPolicy. +This policy will use all the existing values except one: AllowNetworkConfigurationSettingsLookup; in this example, we will fetch network roaming policy for the non-EV user with NonEVNetworkRoamingPolicy based on his current network location. + +## PARAMETERS + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnnotations + +This setting will allow admins to choose which users will be able to use the Annotation feature. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToDialOut + +Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToJoinMeeting +> [!NOTE] +> The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. + +Determines whether anonymous users can join the meetings that impacted users organize. Set this to TRUE to allow anonymous users to join a meeting. Set this to FALSE to prohibit them from joining a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnonymousUsersToStartMeeting +Determines whether anonymous users can initiate a meeting. Set this to TRUE to allow anonymous users to initiate a meeting. Set this to FALSE to prohibit them from initiating a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowAvatarsInGallery + +If admins disable avatars in 2D meetings, then users cannot represent themselves as avatars in the Gallery view. This does not disable avatars in Immersive view. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCarbonSummary + +This setting will enable Tenant Admins to enable/disable the sharing of location data necessary to provide the end of meeting carbon summary screen for either the entire tenant or for a particular user. +If set to True the meeting organizer will share their location to the client of the participant to enable the calculation of distance and the resulting carbon. + +> [!NOTE] +> Location data will not be visible to the organizer or participants in this case and only carbon avoided will be shown. +If set to False then organizer location data will not be shown and no carbon summary screen will be displayed to the participants. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCartCaptionsScheduling +Determines whether a user can add a URL for captions from a Communications Access Real-Time Translation (CART) captioner for providing real time captions in meetings. +Possible values are: + +- **EnabledUserOverride**, CART captions is available by default but a user can disable. +- **DisabledUserOverride**, if you would like users to be able to use CART captions in meetings but by default it is disabled. +- **Disabled**, if you'd like to not allow CART captions in meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCloudRecording +Determines whether cloud recording is allowed in a user's meetings. Set this to TRUE to allow the user to be able to record meetings. Set this to FALSE to prohibit the user from recording meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowDocumentCollaboration + +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowEngagementReport +Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: + +- Enabled: allow the meeting organizer to download the report. +- Disabled: disable attendee report generation and prohibit meeting organizer from downloading it. +- ForceEnabled: enable attendee report generation and prohibit meeting organizer from disabling it. + +If set to Enabled or ForceEnabled, only meeting organizers and co-organizers will get a link to download the report in Teams. Regular attendees will have no access to it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalNonTrustedMeetingChat + +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalParticipantGiveRequestControl +Determines whether external participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit an external user from giving or requesting control in a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveView + +If admins have disabled avatars, this does not disable using avatars in Immersive view on Teams desktop or web. Additionally, it does not prevent users from joining the Teams meeting on VR headsets. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPAudio +Determines whether audio is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their audio. Set this to FALSE to prohibit the user from sharing their audio. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowIPVideo +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingCoach +This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. + If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. + If set to False, then users will not have the option to turn on Meeting Coach during calls. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. + +Possible values: + +- True +- False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOrganizersToOverrideLobbySettings +This parameter has been deprecated and currently has no effect. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOutlookAddIn +Determines whether a user can schedule Teams Meetings in Outlook desktop client. Set this to TRUE to allow the user to be able to schedule Teams meetings in Outlook client. Set this to FALSE to prohibit a user from scheduling Teams meeting in Outlook client. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowParticipantGiveRequestControl +Determines whether participants can request or give control of screen sharing during meetings scheduled by this user. Set this to TRUE to allow the user to be able to give or request control. Set this to FALSE to prohibit the user from giving, requesting control in a meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPowerPointSharing +Determines whether Powerpoint sharing is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateMeetNow +This setting controls whether a user can start an ad hoc private meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateMeetingScheduling +Determines whether a user can schedule private meetings. Set this to TRUE to allow a user to schedule private meetings. Set this to FALSE to prohibit the user from scheduling private meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPSTNUsersToBypassLobby +Determines whether a PSTN user joining the meeting is allowed or not to bypass the lobby. If you set this parameter to **True**, PSTN users are allowed to bypass the lobby as long as an authenticated user is joined to the meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRecordingStorageOutsideRegion +Allows storing recordings outside of the region. All meeting recordings will be permanently stored in another region, and can't be migrated. This does not apply to recordings saved in OneDrive or SharePoint. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowScreenContentDigitization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSharedNotes +Determines whether users are allowed to take shared Meeting notes. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTasksFromTranscript + +This policy setting allows for the extraction of AI-Assisted Action Items/Tasks from the Meeting Transcript. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTrackingInReport +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowTranscription +Determines whether post-meeting captions and transcriptions are allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext + +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserToJoinExternalMeeting +Currently, this parameter has no effect. + +Possible values are: + +- Enabled +- FederatedOnly +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingContext +This policy controls which users should have the ability to see the meeting info details on the join screen. 'None' option should disable the feature completely. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExternalNonTrustedMeetingChat +This field controls whether a user is allowed to chat in external meetings with users from non-trusted organizations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWatermarkForCameraVideo +This setting allows scheduling meetings with watermarking for video enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowWhiteboard +Determines whether whiteboard is allowed in a user's meetings. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedStreamingMediaInput +Enables the use of RTMP-In in Teams meetings. + +Possible values are: + +- \ +- RTMP + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnonymousUserAuthenticationMethod +Determines how anonymous users will be authenticated when joining a meeting. +Possible values are: + +- **OneTimePasscode**, if you would like anonymous users to be sent a one time passcode to their email when joining a meeting +- **None**, if you would like to disable authentication for anonymous users joining a meeting + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: OneTimePasscode +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttendeeIdentityMasking + +This setting will allow admins to enable or disable Masked Attendee mode in Meetings. +Masked Attendee meetings will hide attendees' identifying information (e.g., name, contact information, profile photo). + +Possible Values: Enabled: Hides attendees' identifying information in meetings. Disabled: Does not allow attendees' to hide identifying information in meetings + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudibleRecordingNotification + +The setting controls whether recording notification is played to all attendees or just PSTN users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRecording + +This setting allows admins to control the visibility of the auto recording feature in the organizer's **Meeting options**. If the you enable this setting, the **Record and transcribe automatically** setting appears in **Meeting options** with the default value set to **Off** (except for webinars and townhalls). Organizers need to manually toggle this setting to **On** to for their meetings to be automatically recorded. If you disable this setting, **Record and transcribe automatically** is hidden, preventing organizers from setting any meetings to be auto-recorded. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoAdmittedUsers +Determines what types of participants will automatically be added to meetings organized by this user. +Possible values are: + +- **EveryoneInCompany**, if you would like meetings to place every external user in the lobby but allow all users in the company to join the meeting immediately. +- **EveryoneInSameAndFederatedCompany**, if you would like meetings to allow federated users to join like your company's users, but place all other external users in a lobby. +- **Everyone**, if you'd like to admit anonymous users by default. +- **OrganizerOnly**, if you would like that only meeting organizers can bypass the lobby. +- **EveryoneInCompanyExcludingGuests**, if you would like meetings to place every external and guest users in the lobby but allow all other users in the company to join the meeting immediately. +- **InvitedUsers**, if you would like that only meeting organizers and invited users can bypass the lobby. + +This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomaticallyStartCopilot +> [!NOTE] +> This feature has not been fully released yet, so the setting will have no effect. + +This setting gives admins the ability to auto-start Copilot. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockedAnonymousJoinClientTypes +A user can join a Teams meeting anonymously using a [Teams client](https://support.microsoft.com/office/join-a-meeting-without-a-teams-account-c6efc38f-4e03-4e79-b28f-e65a4c039508) or using a [custom application built using Azure Communication Services](https://learn.microsoft.com/azure/communication-services/concepts/join-teams-meeting). When anonymous meeting join is enabled, both types of clients may be used by default. This optional parameter can be used to block one of the client types that can be used. + +The allowed values are ACS (to block the use of Azure Communication Services clients) or Teams (to block the use of Teams clients). Both can also be specified, separated by a comma, but this is equivalent to disabling anonymous join completely. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Empty List +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaptchaVerificationForMeetingJoin +Require a verification check for meeting join. + +Possible values: +- **NotRequired**, CAPTCHA not required to join the meeting +- **AnonymousUsersAndUntrustedOrganizations**, Anonymous users and people from untrusted organizations must complete a CAPTCHA challenge to join the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelRecordingDownload +Controls how channel meeting recordings are saved, permissioned, and who can download them. + +Possible values: + +- Allow - Saves channel meeting recordings to a "Recordings" folder in the channel. The permissions on the recording files will be based on the Channel SharePoint permissions. This is the same as any other file uploaded for the channel. +- Block - Saves channel meeting recordings to a "Recordings\View only" folder in the channel. Channel owners will have full rights to the recordings in this folder, but channel members will have read access without the ability to download. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Allow +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSharingInExternalMeetings +This policy allows admins to determine whether the user can share content in meetings organized by external organizations. The user should have a Teams Premium license to be protected under this policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Copilot +This setting allows the admin to choose whether Copilot will be enabled with a persisted transcript or a non-persisted transcript. + +Possible values are: + +- Enabled +- EnabledWithTranscript + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyRestriction +This parameter enables a setting that controls a meeting option which allows users to disable right-click or Ctrl+C to copy, Copy link, Forward message, and Share to Outlook for meeting chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Enables administrators to provide explanatory text about the meeting policy. +For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedPresenterRoleMode +Determines if users can change the default value of the _Who can present?_ setting in Meeting options in the Teams client. This policy setting affects all meetings, including Meet Now meetings. + +Possible values are: + +- EveryoneUserOverride: All meeting participants can be presenters. This is the default value. This parameter corresponds to the _Everyone_ setting in Teams. +- EveryoneInCompanyUserOverride: Authenticated users in the organization, including guest users, can be presenters. This parameter corresponds to the _People in my organization_ setting in Teams. +- EveryoneInSameAndFederatedCompanyUserOverride: Authenticated users in the organization, including guest users and users from federated organizations, can be presenters. This parameter corresponds to the _People in my organization and trusted organizations_ setting in Teams. +- OrganizerOnlyUserOverride: Only the meeting organizer can be a presenter and all meeting participants are designated as attendees. This parameter corresponds to the _Only me_ setting in Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DetectSensitiveContentDuringScreenSharing + +Allows the admin to enable sensitive content detection during screen share. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnrollUserOverride +Turn on/off Biometric enrollment +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExplicitRecordingConsent +Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. + +Possible Values: + +- Enabled: Explicit consent, requires participant agreement. +- Disabled: Implicit consent, does not require participant agreement. +- LegitimateInterest: Legitimate interest, less restrictive consent to meet legitimate interest without requiring explicit agreement from participants. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMeetingJoin +Determines whether the user is allowed to join external meetings. + +Possible values are: + +- EnabledForAnyone +- EnabledForTrustedOrgs +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: EnabledForAnyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfoShownInReportMode + +This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMode +Determines whether audio can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming audio in the meeting. Set this to DISABLED to prohibit outgoing and incoming audio in the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMode +Determines whether video can be turned on in meetings and group calls. Set this to ENABLEDOUTGOINGINCOMING to allow outgoing and incoming video in the meeting. Set this to DISABLED to prohibit outgoing and incoming video in the meeting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveCaptionsEnabledType +Determines whether real-time captions are available for the user in Teams meetings. Set this to DisabledUserOverride to allow user to turn on live captions. Set this to Disabled to prohibit. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveInterpretationEnabledType +Allows meeting organizers to configure a meeting for language interpretation, selecting attendees of the meeting to become interpreters that other attendees can select and listen to the real-time translation they provide. +Possible values are: + +- **DisabledUserOverride**, if you would like users to be able to use interpretation in meetings but by default it is disabled. +- **Disabled**, prevents the option to be enabled in Meeting Options. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: DisabledUserOverride +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LiveStreamingMode +Determines whether you provide support for your users to stream their Teams meetings to large audiences through Real-Time Messaging Protocol (RTMP). + +Possible values are: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LobbyChat + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Determines whether chat messages are allowed in the lobby. + +Possible values are: + +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingChatEnabledType +Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. + +> [!NOTE] +> Due to a new feature rollout, in order to set the value of MeetingChatEnabledType to Disabled, you will need to also set the value of LobbyChat to disabled. e.g., +> Install-Module MicrosoftTeams -RequiredVersion 6.6.1-preview -Force -AllowClobber -AllowPrereleaseConnect-MicrosoftTeams Set-CsTeamsMeetingPolicy -Identity Global -MeetingChatEnabledType Disabled -LobbyChat Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingInviteLanguages +Controls how the join information in meeting invitations is displayed by enforcing a common language or enabling up to two languages to be displayed. + +> [!NOTE] +> All Teams supported languages can be specified using language codes. For more information about its delivery date, see the [roadmap (Feature ID: 81521)](https://www.microsoft.com/microsoft-365/roadmap?filters=&searchterms=81521). + +The preliminary list of available languages is shown below: + +`ar-SA,az-Latn-AZ,bg-BG,ca-ES,cs-CZ,cy-GB,da-DK,de-DE,el-GR,en-GB,en-US,es-ES,es-MX,et-EE,eu-ES,fi-FI,fil-PH,fr-CA,fr-FR,gl-ES,he-IL,hi-IN,hr-HR,hu-HU,id-ID,is-IS,it-IT,ja-JP,ka-GE,kk-KZ,ko-KR,lt-LT,lv-LV,mk-MK,ms-MY,nb-NO,nl-NL,nn-NO,pl-PL,pt-BR,pt-PT,ro-RO,ru-RU,sk-SK,sl-SL,sq-AL,sr-Latn-RS,sv-SE,th-TH,tr-TR,uk-UA,vi-VN,zh-CN,zh-TW`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewMeetingRecordingExpirationDays +Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. Value can also be -1 to set meeting recordings to never expire. + +> [!NOTE] +> You may opt to set Meeting Recordings to never expire by entering the value -1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -NoiseSuppressionForDialInParticipants + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Control Noises Supression Feature for PST legs joining a meeting. + +Possible Values: + +- MicrosoftDefault +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParticipantNameChange + +This setting will enable Tenant Admins to turn on/off participant renaming feature. + +Possible Values: +Enabled: Turns on the Participant Renaming feature. +Disabled: Turns off the Participant Renaming feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMeetingProviderForIslandsMode +Determines the Outlook meeting add-in available to users on Islands mode. By default, this is set to TeamsAndSfb, and the users sees both the Skype for Business and Teams add-ins. Set this to Teams to remove the Skype for Business add-in and only show the Teams add-in. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TeamsAndSfb +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QnAEngagementMode + +This setting enables Microsoft 365 Tenant Admins to Enable or Disable the Questions and Answers experience (Q+A). + When Enabled, Organizers can turn on Q+A for their meetings. When Disabled, Organizers cannot turn on Q+A in their meetings. + The setting is enforced when a meeting is created or is updated by Organizers. + Attendees can use Q+A in meetings where it was previously added. Organizers can remove Q+A for those meetings through Teams and Outlook Meeting Options. +Possible values: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecordingStorageMode +This parameter can take two possible values: + +- Stream +- OneDriveForBusiness + +> [!NOTE] +> The change of storing Teams meeting recordings from Classic Stream to OneDrive and SharePoint (ODSP) has been completed as of August 30th, 2021. All recordings are now stored in ODSP. This change overrides the RecordingStorageMode parameter, and modifying the setting in PowerShell no longer has any impact. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomAttributeUserOverride +Possible values: + +- Off +- Distinguish +- Attribute + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoomPeopleNameUserOverride + +Enabling people recognition requires the tenant CsTeamsMeetingPolicy roomPeopleNameUserOverride to be "On" and roomAttributeUserOverride to be Attribute for allowing individual voice and face profiles to be used for recognition in meetings. + +> [!NOTE] +> In some locations, people recognition can't be used due to local laws or regulations. +Possible values: +> +> - Off: No People Recognition option on Microsoft Teams Room (Default). +> - On: Policy value allows People recognition option on Microsoft Teams Rooms under call control bar. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScreenSharingMode +Determines the mode in which a user can share a screen in calls or meetings. Set this to SingleApplication to allow the user to share an application at a given point in time. Set this to EntireScreen to allow the user to share anything on their screens. Set this to Disabled to prohibit the user from sharing their screens. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmsNotifications +Participants can sign up for text message meeting reminders. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpeakerAttributionMode +Determines if users are identified in transcriptions and if they can change the value of the _Automatically identify me in meeting captions and transcripts_ setting. + +Possible values: + +- **Enabled**: Speakers are identified in transcription. +- **EnabledUserOverride**: Speakers are identified in transcription. If enabled, users can override this setting and choose not to be identified in their Teams profile settings. +- **DisabledUserOverride**: Speakers are not identified in transcription. If enabled, users can override this setting and choose to be identified in their Teams profile settings. +- **Disabled**: Speakers are not identified in transcription. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamingAttendeeMode + +Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality). + +Possible values are: + +- Disabled +- Enabled + +Set this to Enabled to allow up to 20,000 extra view-only attendees to join. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCameraFarEndPTZMode +Possible values are: + +- Disabled +- AutoAcceptInTenant +- AutoAcceptAll + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanAdmitFromLobby + +This policy controls who can admit from the lobby. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoFiltersMode +Determines the background effects that a user can configure in the Teams client. Possible values are: + +- NoFilters: No filters are available. +- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://learn.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). +- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. +- AllFilters: All filters are available, including custom images. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceIsolation +Determines whether you provide support for your users to enable voice isolation in Teams meeting calls. + +Possible values are: +- Enabled (default) +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VoiceSimulationInInterpreter + +> [!NOTE] +> This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the voice simulation feature while being AI interpreted. + +Possible Values: + +- Disabled +- Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForAnonymousUsers + +Determines the meeting experience and watermark content of an anonymous user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoOpacity + +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForCameraVideoPattern + +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingOpacity + +Allows the transparency of watermark to be customizable. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatermarkForScreenSharingPattern + +Allows the pattern design of watermark to be customizable. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. + +Possible Values: +- UsersAllowedToByPassTheLobby: Users who are able to bypass lobby can see the meeting info details. +- Everyone: All meeting participants can see the meeting info details. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: UsersAllowedToByPassTheLobby +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. + +Possible Values: +- Enabled: User is allowed to turn on real time text. +- Disabled: User is not allowed to turn on real time text. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +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 +``` + +### -WhoCanRegister +Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts set the value to 'EveryoneInCompany'. + +Possible values: + +- Everyone +- EveryoneInCompany + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md new file mode 100644 index 0000000000..e9a319c5d3 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsMeetingTemplatePermissionPolicy +author: boboPD +ms.author: pradas +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMeetingTemplatePermissionPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsMeetingTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsMeetingTemplatePermissionPolicy. + +## SYNTAX + +```powershell + Set-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-HiddenMeetingTemplates ] [-Description ] [-Force][-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Update any of the properties of an existing instance of the TeamsMeetingTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 - Updating the description of an existing policy + +```powershell +PS> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -Description "updated description" +``` + +Updates the description field of a policy. + +### Example 2 - Updating the hidden meeting template list of an existing policy + +```powershell +PS> Set-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -HiddenMeetingTemplates @($hiddentemplate_1, $hiddentemplate_2) +``` + +Updates the hidden meeting templates array. + +## PARAMETERS + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenMeetingTemplates + +The updated list of meeting template IDs to hide. +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). + +```yaml +Type: HiddenMeetingTemplate[] +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) + +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) + +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) + +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md new file mode 100644 index 0000000000..d7182ff633 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md @@ -0,0 +1,818 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsMessagingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsMessagingPolicy + +## SYNOPSIS +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsMessagingPolicy [[-Identity] ] + [-AllowChatWithGroup ] + [-AllowCommunicationComplianceEndUserReporting ] + [-AllowCustomGroupChatAvatars ] + [-AllowExtendedWorkInfoInSearch ] + [-AllowFluidCollaborate ] + [-AllowFullChatPermissionUserToDeleteAnyMessage ] + [-AllowGiphy ] + [-AllowGiphyDisplay ] + [-AllowGroupChatJoinLinks ] + [-AllowImmersiveReader ] + [-AllowMemes ] + [-AllowOwnerDeleteMessage ] + [-AllowPasteInternetImage ] + [-AllowPriorityMessages ] + [-AllowRemoveUser ] + [-AllowSecurityEndUserReporting ] + [-AllowSmartCompose] ] + [-AllowSmartReply ] + [-AllowStickers ] + [-AllowUrlPreviews ] + [-AllowUserChat ] + [-AllowUserDeleteChat ] + [-AllowUserDeleteMessage ] + [-AllowUserEditMessage ] + [-AllowUserTranslation ] + [-AllowVideoMessages ] + [-AudioMessageEnabledType ] + [-ChannelsInChatListEnabledType ] + [-ChatPermissionRole ] + [-Confirm] + [-CreateCustomEmojis ] + [-DeleteCustomEmojis ] + [-Description ] + [-DesignerForBackgroundsAndImages ] + [-Force] + [-GiphyRatingType ] + [-InOrganizationChatControl ] + [-ReadReceiptsEnabledType ] + [-Tenant ] + [-UsersCanDeleteBotMessages ] + [-WhatIf] + [] +``` + +### Instance +``` +Set-CsTeamsMessagingPolicy [-Instance ] + [-AllowChatWithGroup ] + [-AllowCommunicationComplianceEndUserReporting ] + [-AllowCustomGroupChatAvatars ] + [-AllowExtendedWorkInfoInSearch ] + [-AllowFluidCollaborate ] + [-AllowFullChatPermissionUserToDeleteAnyMessage ] + [-AllowGiphy ] + [-AllowGiphyDisplay ] + [-AllowGroupChatJoinLinks ] + [-AllowImmersiveReader ] + [-AllowMemes ] + [-AllowOwnerDeleteMessage ] + [-AllowPasteInternetImage ] + [-AllowPriorityMessages ] + [-AllowRemoveUser ] + [-AllowSecurityEndUserReporting ] + [-AllowSmartCompose] ] + [-AllowSmartReply ] + [-AllowStickers ] + [-AllowUrlPreviews ] + [-AllowUserChat ] + [-AllowUserDeleteChat ] + [-AllowUserDeleteMessage ] + [-AllowUserEditMessage ] + [-AllowUserTranslation ] + [-AllowVideoMessages ] + [-AudioMessageEnabledType ] + [-ChannelsInChatListEnabledType ] + [-Confirm] + [-CreateCustomEmojis ] + [-DeleteCustomEmojis ] + [-Description ] + [-DesignerForBackgroundsAndImages ] + [-Force] + [-GiphyRatingType ] + [-InOrganizationChatControl ] + [-ReadReceiptsEnabledType ] + [-Tenant ] + [-UsersCanDeleteBotMessages ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is enabled to exchange messages. These also help determine the type of messages users can create and modify. This cmdlet updates a Teams messaging policy. Custom policies can then be assigned to users using the Grant-CsTeamsMessagingPolicy cmdlet. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy -AllowGiphy $false -AllowMemes $false +``` + +In this example two different property values are configured: AllowGiphy is set to false and AllowMemes is set to False. +All other policy properties will be left as previously assigned. + +### Example 2 + +```powershell +PS C:\> Get-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy | Set-CsTeamsMessagingPolicy -AllowGiphy $false -AllowMemes $false +``` + +In this example two different property values are configured for all teams messaging policies in the organization: AllowGiphy is set to false and AllowMemes is set to False. +All other policy properties will be left as previously assigned. + +## PARAMETERS + +### -Identity +Identity for the teams messaging policy you're modifying. To modify the global policy, use this syntax: -Identity global. To modify a per-user policy, use syntax similar to this: `-Identity TeamsMessagingPolicy`. + +If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowChatWithGroup +This setting determines if users can chat with groups (Distribution, M365 and Security groups). +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCommunicationComplianceEndUserReporting +This setting determines if users can report offensive messages to their admin for Communication Compliance. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCustomGroupChatAvatars +These settings enables, disables updating or fetching custom group chat avatars for the users included in the messaging policy. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowExtendedWorkInfoInSearch +This setting enables/disables showing company name and department name in search results for MTO users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFluidCollaborate +This field enables or disables Fluid Collaborate feature for users. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowFullChatPermissionUserToDeleteAnyMessage +This setting determines if users with the 'Full permissions' role can delete any group or meeting chat message within their tenant. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphy +Determines whether a user is allowed to access and post Giphys. Set this to TRUE to allow. Set this FALSE to prohibit. + +**Note**: [Optional Connected Experiences](https://learn.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for Giphys to be allowed. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGiphyDisplay +Determines if Giphy images should be displayed that had been already sent or received in chat. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowGroupChatJoinLinks +This setting determines if users in a group chat can create and share join links for other users within the organization to join that chat. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowImmersiveReader +Determines whether a user is allowed to use Immersive Reader for reading conversation messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMemes +Determines whether a user is allowed to access and post memes. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowOwnerDeleteMessage +Determines whether owners are allowed to delete all the messages in their team. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPasteInternetImage +Determines if a user is allowed to paste internet-based images in compose. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPriorityMessages +Determines whether a user is allowed to send priority messages. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowRemoveUser +Determines whether a user is allowed to remove a user from a conversation. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSecurityEndUserReporting +This setting determines if users can report any security concern posted in message to their admin. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartCompose +Turn on this setting to let a user get text predictions for chat messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Con nombre +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowSmartReply +Turn this setting on to enable suggested replies for chat messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowStickers +Determines whether a user is allowed to access and post stickers. Set this to TRUE to allow. Set this FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUrlPreviews +Use this setting to turn automatic URL previewing on or off in messages. Set this to TRUE to turn on. Set this to FALSE to turn off. + +Note that [Optional Connected Experiences](https://learn.microsoft.com/deployoffice/privacy/manage-privacy-controls#policy-setting-for-optional-connected-experiences) must be also enabled for URL previews to be allowed. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserChat +Determines whether a user is allowed to chat. Set this to TRUE to allow a user to chat across private chat, group chat and in meetings. Set this to FALSE to prohibit all chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteChat +Turn this setting on to allow users to permanently delete their 1:1, group chat, and meeting chat as participants (this deletes the chat only for them, not other users in the chat). Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserDeleteMessage +Determines whether a user is allowed to delete their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. +If this value is set to FALSE, the team owner will not be able to delete their own messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserEditMessage +Determines whether a user is allowed to edit their own messages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserTranslation +Determines whether a user is allowed to translate messages to their client languages. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowVideoMessages +This setting determines if users can create and send video messages. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AudioMessageEnabledType +Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels, ChatsOnly, Disabled. + +```yaml +Type: AudioMessageEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChannelsInChatListEnabledType +On mobile devices, enable to display favorite channels above recent chats. + +Possible values are: DisabledUserOverride, EnabledUserOverride. + +```yaml +Type: ChannelsInChatListEnabledTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChatPermissionRole +Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the environment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. + +```yaml +Type: String +Position: Named +Default value: Restricted +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateCustomEmojis +This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteCustomEmojis +These settings enable and disable the editing and deletion of custom emojis and reactions for the users included in the messaging policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of your policy to identify purpose of creating it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignerForBackgroundsAndImages +This setting determines whether a user is allowed to create custom AI-powered backgrounds and images with MS Designer. + +Possible values are: Enabled, Disabled. + +```yaml +Type: DesignerForBackgroundsAndImagesTypeEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GiphyRatingType +Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InOrganizationChatControl +This setting determines if chat regulation for internal communication in the tenant is allowed. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReadReceiptsEnabledType +Use this setting to specify whether read receipts are user controlled, enabled for everyone, or disabled. Set this to UserPreference, Everyone or None. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UsersCanDeleteBotMessages +Determines whether a user is allowed to delete messages sent by bots. Set this to TRUE to allow. Set this to FALSE to prohibit. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md similarity index 82% rename from skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md index 83ba496b74..483c23e72a 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md @@ -1,166 +1,179 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsmobilitypolicy -applicable: Skype for Business Online -title: Set-CsTeamsMobilityPolicy -schema: 2.0.0 -manager: ritikag -ms.reviewer: ritikag ---- - - -# Set-CsTeamsMobilityPolicy - -## SYNOPSIS -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] - [-IPAudioMobileMode ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -``` -Set-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] - [-IPAudioMobileMode ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. - -The Set-CsTeamsMobilityPolicy cmdlet allows administrators to update teams mobility policies. - -NOTE: Please note that this cmdlet was deprecated and then removed from this PowerShell module. This reference will continue to be listed here for legacy purposes. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-CsTeamsMobilityPolicy -Identity SalesPolicy -IPVideoMobileMode "WifiOnly -``` -The command shown in Example 1 uses the Set-CsTeamsMobilityPolicy cmdlet to update an existing teams mobility policy with the Identity SalesPolicy. This SalesPolicy will not have IPVideoMobileMode equal to "WifiOnly". - -## 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 -``` - -### -Description -Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Bypasses all non-fatal errors. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAudioMobileMode -When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPVideoMobileMode -When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specify the name of the policy that you are creating. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -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 - -### System.Management.Automation.PSObject - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmobilitypolicy +applicable: Microsoft Teams +title: Set-CsTeamsMobilityPolicy +schema: 2.0.0 +manager: ritikag +ms.reviewer: ritikag +--- + +# Set-CsTeamsMobilityPolicy + +## SYNOPSIS +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] + [-IPAudioMobileMode ] [[-Identity] ] [-MobileDialerPreference ] [-Force] [-WhatIf] [-Confirm] [] +``` + +### Instance +``` +Set-CsTeamsMobilityPolicy [-Tenant ] [-Description ] [-IPVideoMobileMode ] + [-IPAudioMobileMode ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The TeamsMobilityPolicy allows Admins to control Teams mobile usage for users. + +The Set-CsTeamsMobilityPolicy cmdlet allows administrators to update teams mobility policies. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsMobilityPolicy -Identity SalesPolicy -IPVideoMobileMode "WifiOnly +``` +The command shown in Example 1 uses the Set-CsTeamsMobilityPolicy cmdlet to update an existing teams mobility policy with the Identity SalesPolicy. This SalesPolicy will not have IPVideoMobileMode equal to "WifiOnly". + +## 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 +``` + +### -Description +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Bypasses all non-fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPAudioMobileMode +When set to WifiOnly, prohibits the user from making, receiving calls or joining meetings using VoIP calls on the mobile device while on cellular data connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IPVideoMobileMode +When set to WifiOnly, prohibits the user from making, receiving video calls or enabling video in meetings using VoIP calls on the mobile device while on cellular data connection. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy that you are creating. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MobileDialerPreference +Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. +For more information, see [Manage user incoming calling policies](https://learn.microsoft.com/microsoftteams/operator-connect-mobile-configure#manage-user-incoming-calling-policies). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +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 + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md new file mode 100644 index 0000000000..0e092c6abe --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsMultiTenantOrganizationConfiguration.md @@ -0,0 +1,89 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +applicable: Microsoft Teams +title: Set-CsTeamsMultiTenantOrganizationConfiguration +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmultitenantorganizationconfiguration +schema: 2.0.0 +author: samlyu +ms.author: samlyu +--- + +# Set-CsTeamsMultiTenantOrganizationConfiguration + +## SYNOPSIS + +This cmdlet configures the Multi-tenant Organization settings for the tenant. + +## SYNTAX + +``` +Set-CsTeamsMultiTenantOrganizationConfiguration + [[-Identity] ] + [-CopilotFromHomeTenant ] +``` + +## DESCRIPTION +The Set-CsTeamsMultiTenantOrganizationConfiguration cmdlet configures tenant settings for Multi-tenant Organizations. This includes the CopilotFromHomeTenant parameter, which determines if users in a Multi-Tenant Organization can use their Copilot license from their home tenant during cross-tenant meetings + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsMultiTenantOrganizationConfiguration -Identity Global -CopilotFromHomeTenant Disabled +``` + +Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "Disabled" for global as default. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsMultiTenantOrganizationConfiguration -Identity Global -CopilotFromHomeTenant Enabled + +``` + +Set Teams Multi-tenant Organization Setting "CopilotFromHomeTenant" value to "Enabled" for global as default. + +## PARAMETERS + +### -Identity +Identity of the Teams Multi-tenant Organization Setting. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopilotFromHomeTenant +Setting value of the Teams Multi-tenant Organization Setting. CopilotFromHomeTenant controls user access to Copilot license in their home tenant during cross-tenant meetings. + +```yaml +Type: Boolean +Parameter Sets: ("Enabled","Disabled") +Aliases: + +Required: True +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-CsTeamsMultiTenantOrganizationConfiguration](Get-CsTeamsMultiTenantOrganizationConfiguration.md) diff --git a/skype/skype-ps/skype/Set-CsTeamsNetworkRoamingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md similarity index 79% rename from skype/skype-ps/skype/Set-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md index c150d32c9e..f7d01f2e45 100644 --- a/skype/skype-ps/skype/Set-CsTeamsNetworkRoamingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsnetworkroamingpolicy -applicable: Skype for Business Online +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnetworkroamingpolicy +applicable: Microsoft Teams title: Set-CsTeamsNetworkRoamingPolicy author: TristanChen-msft ms.author: jiaych -ms.reviewer: +ms.reviewer: manager: mreddy schema: 2.0.0 --- @@ -20,7 +20,12 @@ Set-CsTeamsNetworkRoamingPolicy allows IT Admins to create or update policies fo ## SYNTAX ``` -Set-CsTeamsNetworkRoamingPolicy [-Tenant ] [-Identity ] [-AllowIPVideo ] [-MediaBitRateKb ] [-Description ] +Set-CsTeamsNetworkRoamingPolicy [-Identity ] + [-AllowIPVideo ] + [-Description ] + [-MediaBitRateKb ] + [-Tenant ] + [] ``` ## DESCRIPTION @@ -28,9 +33,9 @@ Updates or creates new Teams Network Roaming Policies configured for use in your The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific settings from the TeamsMeetingPolicy to be rendered dynamically based upon the location of the Teams client. The TeamsNetworkRoamingPolicy cannot be granted to a user but instead can be assigned to a network site. The settings from the TeamsMeetingPolicy included are AllowIPVideo and MediaBitRateKb. When a Teams client is connected to a network site where a CsTeamRoamingPolicy is assigned, these two settings from the TeamsRoamingPolicy will be used instead of the settings from the TeamsMeetingPolicy. -More on the impact of bit rate setting on bandwidth can be found [here](https://docs.microsoft.com/microsoftteams/prepare-network). +More on the impact of bit rate setting on bandwidth can be found [here](https://learn.microsoft.com/microsoftteams/prepare-network). -To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. +To enable the network roaming policy for users who are not Enterprise Voice enabled, you must also enable the AllowNetworkConfigurationSettingsLookup setting in TeamsMeetingPolicy. This setting is off by default. See Set-TeamsMeetingPolicy for more information on how to enable AllowNetworkConfigurationSettingsLookup for users who are not Enterprise Voice enabled. ## EXAMPLES @@ -59,7 +64,7 @@ Accept wildcard characters: False ``` ### -AllowIPVideo -Determines whether video is enabled in a user's meetings or calls. +Determines whether video is enabled in a user's meetings or calls. Set this to TRUE to allow the user to share their video. Set this to FALSE to prohibit the user from sharing their video. ```yaml @@ -104,6 +109,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 diff --git a/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md new file mode 100644 index 0000000000..b5598c89ee --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsNotificationAndFeedsPolicy.md @@ -0,0 +1,166 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsnotificationandfeedspolicy +title: Set-CsTeamsNotificationAndFeedsPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsNotificationAndFeedsPolicy + +## SYNOPSIS + +Modifies an existing Teams Notifications and Feeds Policy + +## SYNTAX + +```powershell +Set-CsTeamsNotificationAndFeedsPolicy [-Description ] [[-Identity] ] + [-SuggestedFeedsEnabledType ] [-TrendingFeedsEnabledType ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Microsoft Teams notifications and feeds policy allows administrators to manage how notifications and activity feeds are handled within Teams. This policy includes settings that control the types of notifications users receive, how they are delivered, and which activities are highlighted in their feeds. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsNotificationAndFeedsPolicy Global -SuggestedFeedsEnabledType EnabledUserOverride +``` + +Change settings on an existing Notifications and Feeds Policy. + +## 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 +``` + +### -Description + +Free format text + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier assigned to the policy when it was created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuggestedFeedsEnabledType + +The SuggestedFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about suggested activities and content within their Teams environment. When enabled, this parameter ensures that users are notified about recommended or relevant activities, helping them stay informed and engaged with important updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrendingFeedsEnabledType + +The TrendingFeedsEnabledType parameter in the Microsoft Teams notifications and feeds policy controls whether users receive notifications about trending activities within their Teams environment. When enabled, this parameter ensures that users are notified about popular or important activities, helping them stay informed about significant updates and interactions. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md similarity index 77% rename from skype/skype-ps/skype/Set-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/Set-CsTeamsPinnedApp.md index d7f20e4d3d..fac26286e2 100644 --- a/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md +++ b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamspinnedapp -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/skype/set-csteamspinnedapp +applicable: Microsoft Teams title: Set-CsTeamsPinnedApp schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTeamsPinnedApp ## SYNOPSIS -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. +**NOTE**: This cmdlet has been deprecated. As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## SYNTAX @@ -34,11 +34,11 @@ Set-CsTeamsPinnedApp [-Tenant ] [-Order ] [-Priority ``` ## DESCRIPTION -**NOTE**: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience. +**NOTE**: This cmdlet has been deprecated. As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear. -Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . +Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: . ## EXAMPLES @@ -169,14 +169,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md b/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md new file mode 100644 index 0000000000..f41ad5f975 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsRecordingRollOutPolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsrecordingrolloutpolicy +schema: 2.0.0 +applicable: Microsoft Teams +title: Set-CsTeamsRecordingRollOutPolicy +manager: yujin1 +author: ronwa +ms.author: ronwa +--- + +# Set-CsTeamsRecordingRollOutPolicy + +## SYNOPSIS +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. + +## SYNTAX + +``` +Set-CsTeamsRecordingRollOutPolicy [-MeetingRecordingOwnership ] [-Identity] [-Force] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsRecordingRollOutPolicy controls roll out of the change that governs the storage for meeting recordings. This policy would be deprecated over time as this is only to allow IT admins to phase the roll out of this breaking change. + +The Set-CsTeamsRecordingRollOutPolicy cmdlet allows administrators to update existing CsTeamsRecordingRollOutPolicy that can be assigned to particular users to control Teams recording storage place. + +This command is available from Teams powershell module 6.1.1-preview and above. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsRecordingRollOutPolicy -Identity OrganizerPolicy -MeetingRecordingOwnership RecordingInitiator +``` + +The command shown in Example 1 uses the Set-CsTeamsMeetingPolicy cmdlet to update an existing CsTeamsRecordingRollOutPolicy with the Identity OrganizerPolicy. +This policy will set MeetingRecordingOwnership to RecordingInitiator; in this example, recordings for this policy group's users as organizer would get saved to recording initiators' own OneDrive. + +## 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 +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MeetingRecordingOwnership +Specifies where the meeting recording get stored. Possible values are: +- MeetingOrganizer +- RecordingInitiator + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md new file mode 100644 index 0000000000..171a3e9cd7 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsRoomVideoTeleConferencingPolicy.md @@ -0,0 +1,225 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsroomvideoteleconferencingpolicy +title: Set-CsTeamsRoomVideoTeleConferencingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsRoomVideoTeleConferencingPolicy + +## SYNOPSIS + +Modifies the property of an existing TeamsRoomVideoTeleConferencingPolicy. + +## SYNTAX + +```powershell +Set-CsTeamsRoomVideoTeleConferencingPolicy [-AreaCode ] [-Description ] [-Enabled ] + [[-Identity] ] [-PlaceExternalCalls ] [-PlaceInternalCalls ] + [-ReceiveExternalCalls ] [-ReceiveInternalCalls ] [-MsftInternalProcessingMode ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Room Video Teleconferencing Policy enables administrators to configure and manage video teleconferencing behavior for Microsoft Teams Rooms (meeting room devices). + +## PARAMETERS + +### -AreaCode + +GUID provided by the CVI partner that the customer signed the agreement with + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide additional text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +The policy can exist for the tenant but it can be enabled or disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Unique identifier for the policy to be modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceExternalCalls + +The IT admin can configure that their Teams rooms are enabled to place external calls or not, meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlaceInternalCalls + +The IT admin can configure that their Teams rooms are enabled to place internal calls or not. Meaning calls from the Microsoft Teams Rooms to Video teleconferencing devices that are within their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveExternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not, meaning calls from Video teleconferencing devices that are outside their own tenant. +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveInternalCalls + +The IT admin can configure that their Teams rooms are enabled to receive external calls or not. Meaning calls from Video Teleconferencing devices from their own tenant +Value: Enabled, Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md b/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md new file mode 100644 index 0000000000..455aab2ff0 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSettingsCustomApp.md @@ -0,0 +1,95 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssettingscustomapp +title: Set-CsTeamsSettingsCustomApp +schema: 2.0.0 +--- + +# Set-CsTeamsSettingsCustomApp + +## SYNOPSIS +Set the Custom Apps Setting's value of Teams Admin Center. + +## SYNTAX + +``` +Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +There is a switch for managing Custom Apps in the Org-wide App Settings page of Teams Admin Center. The command can set the value of this switch. If the isSideloadedAppsInteractionEnabled is set to true, the switch is enabled. So that the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsSettingsCustomApp -isSideloadedAppsInteractionEnabled $True +``` + +Set the value of Custom Apps Setting to true. + +## 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 +``` + +### -isSideloadedAppsInteractionEnabled +The value to Custom Apps Setting. If the value is true, the custom apps can be uploaded as app packages and available in the organization's app store, vice versa. + +```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 +[Get-CsTeamsSettingsCustomApp](https://learn.microsoft.com/powershell/module/teams/get-csteamssettingscustomapp) diff --git a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md new file mode 100644 index 0000000000..31c805cfbb --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md @@ -0,0 +1,197 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy +applicable: Microsoft Teams +title: Set-CsTeamsSharedCallingRoutingPolicy +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: + +--- + +# Set-CsTeamsSharedCallingRoutingPolicy + +## SYNOPSIS +Use the Set-CsTeamsSharedCallingRoutingPolicy cmdlet to change a shared calling routing policy instance. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsSharedCallingRoutingPolicy [-Identity] [-EmergencyNumbers ] + [-ResourceAccount ] [-Description ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams shared calling routing policy configures the caller ID for normal outbound PSTN and emergency calls made by users enabled for shared calling using this policy instance. + +The caller ID for normal outbound PSTN calls is the phone number assigned to the resource account specified in the policy instance. Typically this is the organization's main auto attendant phone number. Callbacks will go to the auto attendant and the PSTN caller can use the auto attendant to be transferred to the shared calling user. + +When a shared calling user makes an emergency call, the emergency services need to be able to make a direct callback to the user who placed the emergency call. One of the defined emergency numbers is used for this purpose as caller ID for the emergency call. It will be reserved for the next 60 minutes and any inbound call to that number will directly ring the shared calling user who made the emergency call. If no emergency numbers are defined, the phone number of the resource account will be used as caller ID. If no free emergency numbers are available, the first number in the list will be reused. + +The emergency call will contain the location of the shared calling user. The location will either be the dynamic emergency location obtained by the Teams client or if that is not available the static location assigned to the phone number of the resource account used in the shared calling policy instance. + +## EXAMPLES + +### Example 1 +``` +Set-CsTeamsSharedCallingRoutingPolicy -Identity Seattle -EmergencyNumbers @{remove='+14255556677'} +``` +The command shown in Example 1 removes the emergency callback number +14255556677 from the policy called Seattle. + +## PARAMETERS + +### -Identity +Unique identifier of the Teams shared calling routing policy to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the new policy instance. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmergencyNumbers +An array of phone numbers used as caller ID on emergency calls. + +The emergency numbers must be routable for inbound PSTN calls, and for Calling Plan and Operator Connect phone numbers, must be available within the organization. + +The emergency numbers specified must all be of the same phone number type and country as the phone number assigned to the specified resource account. If the resource account has a Calling Plan service number assigned, the emergency numbers need to be Calling Plan subscriber numbers. + +The emergency numbers must be unique and can't be reused in other shared calling policy instances. The emergency numbers can't be assigned to any user or resource account. + +If no emergency numbers are configured, the phone number of the resource account will be used as Caller ID for the emergency call. + +```yaml +Type: System.Management.Automation.PSListModifier[String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceAccount +The Identity of the resource account. Can only be specified using the Identity or ObjectId of the resource account. + +The phone number assigned to the resource account must: +- Have the same phone number type and country as the emergency numbers configured in this policy instance. +- Must have an emergency location assigned. You can use the Teams PowerShell Module [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and the -LocationId parameter to set the location. +- If the resource account is using a Calling Plan service number, you must have a Pay-As-You-Go Calling Plan, and assign it to the resource account. In addition, you need to assign a Communications credits license to the resource account and fund it to support outbound shared calling calls via the Pay-As-You-Go Calling Plan. + +The same resource account can be used in multiple shared calling policy instances. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +Required: False +Position: Named +Default value: False +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: Microsoft Teams + +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). + +## INPUTS + +## OUTPUTS + +## NOTES +In some Calling Plan markets, you are not allowed to set the location on service numbers. In this instance, kindly contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +If you are attempting to use a resource account with an Operator Connect phone number assigned, kindly confirm support for Shared Calling with your operator. + +Shared Calling is not supported for Calling Plan service phone numbers in Romania, the Czech Republic, Hungary, Singapore, New Zealand, Australia, and Japan. A limited number of existing Calling Plan service phone numbers in other countries are also not supported for Shared Calling. For such service phone numbers, you should contact the [Telephone Number Services service desk](https://learn.microsoft.com/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). + +This cmdlet was introduced in Teams PowerShell Module 5.5.0. + +## RELATED LINKS +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) + +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) + +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) + +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) + +[Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md new file mode 100644 index 0000000000..abbbb97e70 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsAppPolicy.md @@ -0,0 +1,133 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsapppolicy +title: Set-CsTeamsShiftsAppPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsAppPolicy + +## SYNOPSIS + +Allows you to set or update properties of a Teams Shifts App Policy instance. + +## SYNTAX + +```powershell +Set-CsTeamsShiftsAppPolicy [-AllowTimeClockLocationDetection ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The Teams Shifts app is designed to help frontline workers and their managers manage schedules and communicate effectively. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsShiftsAppPolicy 'Default' -AllowTimeClockLocationDetection $False +``` + +Change Settings on a Teams Shift App Policy (only works on Global policy) + +## PARAMETERS + +### -AllowTimeClockLocationDetection + +Turns on the location detection. The time report will indicate whether workers are "on location" when they clocked in and out. Workers are considered as "on location" if they clock in or out within a 200-meter radius of the set location. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Policy instance name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..dd1eca6bb1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -0,0 +1,467 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Set-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet sets an existing workforce management (WFM) connection. + +## SYNTAX + +### Set (Default) +```powershell +Set-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +[-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetExpanded +```powershell +Set-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] + [-ConnectorSpecificSettings ] [-Etag ] [-Name ] + [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] +[-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetViaIdentityExpanded +```powershell +Set-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] + [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetViaIdentity +```powershell +Set-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] +[-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet updates a Shifts WFM connection. It allows the admin to make changes to the settings such as the name and WFM URLs. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserName to be included. +This cmdlet can update every input field except -ConnectorId and -ConnectionId. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest ` + -Property @{ + adminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta2" + siteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta2" + essApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta1" + retailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1" + cookieAuthUrl = "https://contoso.com/retail/data/login" + federatedAuthUrl = "https://contoso.com/retail/data/login" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" + +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the instance with the specified -ConnectionId. Returns the object of the updated connection. + +In case of an error, you can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +### Example 2 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Set-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -name "Cmdlet test connection - updated" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + LoginUserName = "PlaceholderForUsername" + LoginPwd = "PlaceholderForPassword" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : a2d1b091-5140-4dd2-987a-98a8b5338744 +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection - updated +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the instance with the specified -ConnectionId. Returns the object of the updated connection. + +In case of an error, you can capture the error response as follows: + +* Hold the cmdlet output in a variable: `$result=` + +* To get the entire error message in Json: `$result.ToJsonString()` + +* To get the error object and object details: `$result, $result.Detail` + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateWfmConnectionRequest +Parameter Sets: Set, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: SetExpanded, Set +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the etag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter. + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connection name. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +The connector-specific settings. + +```yaml +Type: IUpdateWfmConnectionRequestConnectorSpecificSettings +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +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 +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md index d0c86a4d39..eb62460fc0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -1,83 +1,117 @@ --- -external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Set-CsTeamsShiftsConnectionInstance -author: gucsun -ms.author: gucsun -manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance +author: leonardospina +ms.author: lespina +manager: valk +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance schema: 2.0.0 --- # Set-CsTeamsShiftsConnectionInstance ## SYNOPSIS - This cmdlet updates a Shifts connection instance. ## SYNTAX +### Set (Default) +```powershell +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -Body +[-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] +[-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` -Set-CsTeamsShiftsConnectionInstance -ConnectorId -ConnectorInstanceId -ConnectorSpecificSettingAdminApiUrl -ConnectorSpecificSettingCookieAuthUrl -ConnectorSpecificSettingEssApiUrl -ConnectorSpecificSettingFederatedAuthUrl -ConnectorSpecificSettingLoginPwd -ConnectorSpecificSettingLoginUserName -ConnectorSpecificSettingRetailWebApiUrl -ConnectorSpecificSettingSiteManagerUrl -Name -DesignatedActorId -EnabledConnectorScenario -EnabledWfiScenario -SyncFrequencyInMin -IfMatch [-ConnectorAdminEmail ] [] + +### SetExpanded +```powershell +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] +[-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] +[-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] + [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` -## DESCRIPTION +### SetViaIdentityExpanded +```powershell +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] + [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] +[-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] + [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### SetViaIdentity +```powershell +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` -This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. Note that the update allows for, but does not require, the -ConnectorSpecificSettingLoginPwd and ConnectorSpecificSettingLoginUserNameusername to be included. -This cmdlet can update every input fields except -ConnectorId +## DESCRIPTION +This cmdlet updates a Shifts connection instance. It allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. +This cmdlet can update every input field except -ConnectorId and -ConnectorInstanceId. ## EXAMPLES ### Example 1 -```powershell -Set-CsTeamsShiftsConnectionInstance -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E9CD74" -ConnectorInstanceId "WCI-648a8c8f-0ca3-460b-b71c-0d038d6d6e09" -ConnectorSpecificSettingAdminApiUrl "https://nehstdevwfm02.contoso.com/retail/data/wfmadmin/api/v1-beta2" -ConnectorSpecificSettingCookieAuthUrl "https://nehstdevwfm02.contoso.com/retail/data/login" -ConnectorSpecificSettingEssApiUrl "https://nehstdevfas01.contoso.com/retail/data/wfmess/api/v1-beta1" -ConnectorSpecificSettingFederatedAuthUrl "https://nehstdevfas01.contoso.com/retail/data/login" -ConnectorSpecificSettingLoginPwd "MyPassword" -ConnectorSpecificSettingLoginUserName "MyUserName" -ConnectorSpecificSettingRetailWebApiUrl "https://nehstdevwfm02.contoso.com/retail/data/retailwebapi/api/v1" -ConnectorSpecificSettingSiteManagerUrl "https://nehstdevfas01.contoso.com/retail/data/wfmsm/api/v1-beta2" -DesignatedActorId "0c1141fa-1b17-43cc-a417-34c156b99779" -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest" -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest" -Name "MyInstance-Updated" -SyncFrequencyInMin 10 -IfMatch '"0a005fd6-0000-0d00-0000-60a76dbf0000"' -ConnectorAdminEmail "test@abc.com", "test2@abc.com" +```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -connectorAdminEmail @() ` + -designatedActorId "93f85765-47db-412d-8f06-9844718762a1" ` + -State "Active" ` + -syncFrequencyInMin "10" ` + -SyncScenarioOfferShiftRequest "FromWfmToShifts" ` + -SyncScenarioOpenShift "FromWfmToShifts" ` + -SyncScenarioOpenShiftRequest "FromWfmToShifts" ` + -SyncScenarioShift "FromWfmToShifts" ` + -SyncScenarioSwapRequest "FromWfmToShifts" ` + -SyncScenarioTimeCard "FromWfmToShifts" ` + -SyncScenarioTimeOff "FromWfmToShifts" ` + -SyncScenarioTimeOffRequest "FromWfmToShifts" ` + -SyncScenarioUserShiftPreference "Disabled" + +PS C:\> $result.ToJsonString() ``` + ```output + { - "id": "WCI-648a8c8f-0ca3-460b-b71c-0d038d6d6e09", - "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", - "name": "MyInstance-Updated", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E9CD74", - "name": "Blue Yonder V1" - }, - "connectorSpecificSettings": { - "adminApiUrl": "https://nehstdevwfm02.contoso.com/retail/data/wfmadmin/api/v1-beta2", - "siteManagerUrl": "https://nehstdevfas01.contoso.com/retail/data/wfmsm/api/v1-beta2", - "essApiUrl": "https://nehstdevfas01.contoso.com/retail/data/wfmess/api/v1-beta1", - "retailWebApiUrl": "https://nehstdevwfm02.contoso.com/retail/data/retailwebapi/api/v1", - "cookieAuthUrl": "https://nehstdevwfm02.contoso.com/retail/data/login", - "federatedAuthUrl": "https://nehstdevfas01.contoso.com/retail/data/login" - }, - "enabledConnectorScenarios": [ - "Shift", - "SwapRequest", - "UserShiftPreferences", - "OpenShift", - "OpenShiftRequest", - "TimeOff", - "TimeOffRequest", - "TimeCard" - ], - "workforceIntegrationId": "WFI_fe5e773e-784d-4a19-be2b-808dde071d88", - "enabledWfiScenarios": [ - "SwapRequest", - "OpenShiftRequest", - "TimeOffRequest", - "TimeCard" - ], - "syncFrequencyInMin": 10, - "designatedActorId": "5d5eaa2d-422c-4d4b-a2db-4cea80f98255", - "connectorAdminEmails": [ - "test@abc.com", - "test2@abc.com" - ], - "etag": "\"28007861-0000-0400-0000-60d3579b0000\"" + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 10, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state": "Active" } + ``` -Updates the instance with ID `WCI-648a8c8f-0ca3-460b-b71c-0d038d6d6e09` with name `MyInstance-Updated`. Returns the object of created connector instance. +Updates the instance with the specified -ConnectorInstanceId. Returns the object of the updated connector instance. In case of error, we can capture the error response as following: @@ -89,31 +123,69 @@ In case of error, we can capture the error response as following: ## PARAMETERS -### -ConnectorInstanceId +### -Body +The request body -The ID of the connection instance that you want to update. +```yaml +Type: IConnectorInstanceRequest +Parameter Sets: Set, SetViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId +### -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 +``` -The ID of the connection instance creator. You can retrieve user ID from Azure portal or Graph Explorer. +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. + +```yaml +Type: String[] +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorInstanceId +The Id of the connector instance to be updated. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, Set Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -121,15 +193,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch - -The Etag of connection instance. Note: this will be changed after each update of the connection instance. You can get it from instance details using [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md). +### -ConnectionId +Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -137,15 +207,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId - -The ID of the Shifts Connector. +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -153,15 +221,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name - -The connector's instance name. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -169,15 +235,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario - -The connector enabled scenarios that are synced from the Workforce Management (WFM) system to Shifts in Microsoft Teams. You can use [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) to get supported scenarios. +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -185,15 +249,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario - -The WFI enabled scenarios that are synced from Shifts in Microsoft Teams to the WFM system. You can use [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) to get supported scenarios. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -201,15 +263,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncFrequencyInMin - -The sync frequency in minutes. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: Integer -Parameter Sets: (All) +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -217,15 +277,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingLoginUserName - -The login user name to the WFM team. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -233,15 +291,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingLoginPwd - -The login password to the WFM team. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -249,15 +305,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingAdminApiUrl - -The admin API URL. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -265,15 +319,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingCookieAuthUrl +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". -The cookie authorization URL. +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -281,15 +347,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingEssApiUrl +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The essential API URL. +### -IfMatch +The value of the etag field as returned by the cmdlets. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -297,15 +389,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingFederatedAuthUrl +### -InputObject +Identity Parameter. -The federated authorization URL. +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: SetViaIdentityExpanded, SetViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -313,31 +417,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingRetailWebApiUrl +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The retail web API URL. +### -ProxyCredential +Credentials for a proxy server to use for the remote call. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingSiteManagerUrl +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The site manager URL. +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -345,15 +473,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorAdminEmail +### -SyncFrequencyInMin +The sync frequency in minutes. + +```yaml +Type: Int32 +Parameter Sets: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The list of connector admin email addresses that receive result notifications. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) +Aliases: wi +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: -Applicable: Microsoft Teams + Required: False Position: Named Default value: None @@ -366,14 +522,26 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceRequest + ## OUTPUTS +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + ## NOTES ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance) -[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md index 7fc8f9b6ae..6835a0dfa9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-teamsshiftspolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsshiftspolicy +title: Set-CsTeamsShiftsPolicy schema: 2.0.0 --- @@ -9,25 +10,27 @@ schema: 2.0.0 ## SYNOPSIS -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including user's shift based presence and Teams off shift warning message-specific settings. +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance, including Teams off shift warning message-specific settings. ## SYNTAX -``` -Set-CsTeamsShiftsPolicy [[-Identity] ] [-EnableShiftPresence ] [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] [-EnableScheduleOwnerPermissions ] [] +```powershell +Set-CsTeamsShiftsPolicy [-ShiftNoticeFrequency ] [-ShiftNoticeMessageType ] + [-ShiftNoticeMessageCustom ] [-AccessType ] [-AccessGracePeriodMinutes ] + [-EnableScheduleOwnerPermissions ] [-Identity] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name, user's shift based presence (EnableShiftPresence) and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - +This cmdlet allows you to set or update properties of a TeamsShiftPolicy instance. Use this to set the policy name and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -EnableShiftPresence $true -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 +PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage -ShiftNoticeMessageType Message1 -ShiftNoticeFrequency always -AccessGracePeriodMinutes 5 ``` -In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", Shift based presence is enabled (On Shift, Off Shift), a warning message (Message 1) will be always be displayed to the user on opening Teams during off shift hours. +In this example, the policy instance is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage", a warning message (Message 1) will always be displayed to the user on opening Teams during off shift hours. ## PARAMETERS @@ -51,7 +54,6 @@ Indicates the Teams access type granted to the user. Today, only unrestricted ac Use 'UnrestrictedAccess_TeamsApp' as the value for this setting, or is set by default. For Teams Off Shift Access Control, the option to show the user a blocking dialog message is supported. Once the user accepts this message, it is audit logged and the user has usual access to Teams. Set other off shift warning message-specific settings to configure off shift access controls for the user. - ```yaml Type: String Parameter Sets: (All) @@ -64,34 +66,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableShiftPresence -Indicates whether a user is given shift-based presence (On shift, Off shift, or Busy). This must be set in order to have any off shift warning message-specific settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ShiftNoticeMessageType -The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. +The warning message is shown in the blocking dialog when a user access Teams off shift hours. Select one of 7 Microsoft provided messages, a default message or a custom message. 'Message1' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. By accepting, you acknowledge that your use of Teams while off shift is not authorized and you will not be compensated. 'Message2' - Accessing this app outside working hours is voluntary. You won't be compensated for time spent on Teams. Refer to your employer's guidelines on using this app outside working hours. By accepting, you acknowledge that you understand the statement above. 'Message3' - You won't be compensated for time using Teams. By accepting, you acknowledge that you understand the statement above. 'Message4' - You're not authorized to use Teams while off shift. By accepting, you acknowledge your use of Teams is against your employer's policy. 'Message5' - Access to Teams is turned off during non-working hours. You will be able to access the app when your next shift starts. -'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer’s timekeeping system. +'Message6' - Your employer does not authorize or approve of the use of its network, applications, systems, or tools by non-exempt or hourly employees during their non-working hours. Access to corporate resources are only allowed during approved working hours and should be recorded as hours worked in your employer's timekeeping system. 'Message7' - Your employer has turned off access to Teams during non-working hours. Refer to your employer's guidelines on using this app outside working hours. 'DefaultMessage' - You aren't authorized to use Microsoft Teams during non-working hours and will only be compensated for using it during approved working hours. 'CustomMessage' - ```yaml Type: String Parameter Sets: (All) @@ -137,7 +123,6 @@ Accept wildcard characters: False ### -AccessGracePeriodMinutes Indicates the grace period time in minutes between when the first shift starts, or last shift ends and when access is blocked. - ```yaml Type: Int64 Parameter Sets: (All) @@ -165,10 +150,55 @@ 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.Management.Automation.PSObject @@ -176,14 +206,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +[Get-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftspolicy) -[New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +[New-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftspolicy) -[Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +[Remove-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftspolicy) -[Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +[Grant-CsTeamsShiftsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsshiftspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md new file mode 100644 index 0000000000..2163f1d2f1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml +Module Name: MicrosoftTeams +title: Set-CsTeamsSipDevicesConfiguration +author: anmandav +ms.author: anmandav +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssipdevicesconfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsSipDevicesConfiguration + +## SYNOPSIS + +This cmdlet is used to manage the organization-wide Teams SIP devices configuration. + +## SYNTAX + +```powershell +Set-CsTeamsSipDevicesConfiguration [-BulkSignIn ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION + +This cmdlet is used to manage the organization-wide Teams SIP devices configuration which contains settings that are applicable to SIP devices connected to Teams using Teams Sip Gateway. + +To execute the cmdlet, you need to hold a role within your organization such as Teams Administrator or Teams Communication Administrator. + +## EXAMPLES + +### Example 1 + +```powershell +Set-CsTeamsSipDevicesConfiguration -BulkSignIn "Enabled" +``` + +In this example, Bulk SignIn is set to Enabled across the organization. + +### Example 2 + +```powershell +Set-CsTeamsSipDevicesConfiguration -BulkSignIn "Disabled" +``` + +In this example, Bulk SignIn is set to Disabled across the organization. + +## PARAMETERS + +### -BulkSignIn +Indicates whether Bulk SingIn into Teams SIP devices is enabled or disabled for the common area phone (CAP) accounts across the organization. Possible values are **Enabled** and '**Disabled**. + +```yaml +Type: String +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 + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsSipDevicesConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamssipdevicesconfiguration) diff --git a/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md new file mode 100644 index 0000000000..49fabb2ff1 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliance.md @@ -0,0 +1,135 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliance +title: Set-CsTeamsSurvivableBranchAppliance +schema: 2.0.0 +--- + +# Set-CsTeamsSurvivableBranchAppliance + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Set-CsTeamsSurvivableBranchAppliance [-Description ] [[-Identity] ] [-Site ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## 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 +``` + +### -Description + +Description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Site + +The TenantNetworkSite where the SBA is located. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md new file mode 100644 index 0000000000..fe8cc3c54b --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsSurvivableBranchAppliancePolicy.md @@ -0,0 +1,119 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssurvivablebranchappliancepolicy +title: Set-CsTeamsSurvivableBranchAppliancePolicy +schema: 2.0.0 +--- + +# Set-CsTeamsSurvivableBranchAppliancePolicy + +## SYNOPSIS + +The Survivable Branch Appliance (SBA) Policy cmdlets facilitate the continuation of Teams Phone operations, allowing for the placement and reception of Public Switched Telephone Network (PSTN) calls during service disruptions. These cmdlets are exclusively intended for Tenant Administrators and Session Border Controller (SBC) Vendors. In the absence of SBA configuration within a Tenant, the cmdlets will be inoperative. + +## SYNTAX + +```powershell +Set-CsTeamsSurvivableBranchAppliancePolicy [-BranchApplianceFqdns ] [[-Identity] ] + [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] [] +``` + +## PARAMETERS + +### -BranchApplianceFqdns + +The FQDN of the SBA(s) in the site. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md new file mode 100644 index 0000000000..f1e5d3000d --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsTargetingPolicy.md @@ -0,0 +1,204 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstargetingpolicy +title: Set-CsTeamsTargetingPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsTargetingPolicy + +## SYNOPSIS + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +## SYNTAX + +```powershell +Set-CsTeamsTargetingPolicy [-CustomTagsMode ] [-Description ] [[-Identity] ] + [-ManageTagsPermissionMode ] [-ShiftBackedTagsMode ] [-SuggestedPresetTags ] + [-TeamOwnersEditWhoCanManageTagsMode ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The CsTeamsTargetingPolicy cmdlets enable administrators to control the type of tags that users can create or the features that they can access in Teams. It also helps determine how tags deal with Teams members or guest users. + +The Set-CsTeamsTargetingPolicy cmdlet allows administrators to update existing Tenant tag settings that can be assigned to particular teams to control Team features related to tags. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsTargetingPolicy -Identity NewTagPolicy -CustomTagsMode Enabled +``` + +The command shown in Example 1 uses the Set-CsTeamsTargetingPolicy cmdlet to update an existing Tenant tag setting with the CustomTagsMode Enabled. This flag will enable Teams users to create tags. + +## 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 +``` + +### -CustomTagsMode + +Determine whether Teams users can create tags in team. Set this to Enabled to allow users to create new tags. Set this to Disabled to prohibit them from creating new tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Pass in a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageTagsPermissionMode + +Determine whether team users can manage tag settings in Teams. Set this to EnabledTeamOwner to only allow Teams owners to manage tag settings in current Teams. Set this to EnabledTeamOwnerMember to allow Teams owners and Teams members to manage tag settings in current Teams. Set this to EnabledTeamOwnerMemberGuest to allow Teams owners, Teams members and guest users to manage tag settings in current Teams. Set this to MicrosoftDefault to user default setting in current Teams, which will be the same as EnabledTeamOwner. Set this to Disabled to prohibit all users from managing tag settings in current Teams. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For Internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShiftBackedTagsMode + +Determine whether Teams can have tags created by Shift App. Set this to Enabled to allow tags created by Shift App. Set this to Disabled to prohibit tags from Shift App. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamOwnersEditWhoCanManageTagsMode + +Determine whether Teams owners can change Tenant tag settings. Set this to Enabled to allow Teams owners to change Tenant tag settings for current Teams. Set this to Disabled to prohibit them from changing Tenant tag settings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +[Get-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstargetingpolicy) +[Remove-CsTargetingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstargetingpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md new file mode 100644 index 0000000000..8aa49764df --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md @@ -0,0 +1,155 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: Microsoft.Teams.Policy.Administration.Cmdlets.Core +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstemplatepermissionpolicy +title: Set-CsTeamsTemplatePermissionPolicy +author: yishuaihuang4 +ms.author: yishuaihuang +ms.reviewer: +manager: weiliu2 +schema: 2.0.0 +--- + +# Set-CsTeamsTemplatePermissionPolicy + +## SYNOPSIS +This cmdlet updates an existing TeamsTemplatePermissionPolicy. + +## SYNTAX + +``` +Set-CsTeamsTemplatePermissionPolicy + [-HiddenTemplates ] + [-Description ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of the TeamsTemplatePermissionPolicy. + +## EXAMPLES + +### Example 1 +```powershell +PS >$manageEventTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAnEvent +PS >$manageProjectTemplate = New-CsTeamsHiddenTemplate -Id com.microsoft.teams.template.ManageAProject +PS >$HiddenList = @($manageProjectTemplate, $manageEventTemplate) +PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList +``` + +Updates the hidden templates array. + +## 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 +``` + +### -Description +Adds a new description if that field needs to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HiddenTemplates +The updated list of Teams template IDs to hide. +The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddentemplate). + +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.HiddenTemplate] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) + +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) + +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/Set-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md similarity index 82% rename from skype/skype-ps/skype/Set-CsTeamsTranslationRule.md rename to teams/teams-ps/teams/Set-CsTeamsTranslationRule.md index 28e0d71285..64bcdc16c5 100644 --- a/skype/skype-ps/skype/Set-CsTeamsTranslationRule.md +++ b/teams/teams-ps/teams/Set-CsTeamsTranslationRule.md @@ -1,148 +1,145 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csteamstranslationrule -applicable: Microsoft Teams -title: Set-CsTeamsTranslationRule -schema: 2.0.0 -manager: nmurav -author: jenstrier -ms.author: jenstr -ms.reviewer: ---- - -# Set-CsTeamsTranslationRule - -## SYNOPSIS -Cmdlet to modify an existing normalization rule. - -## SYNTAX - -### Identity (Default) -``` -Set-CsTeamsTranslationRule [[-Identity] ] [-Description ] [-Pattern ] [-Translation ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -You can use this cmdlet to modify an existing number manipulation rule. The rule can be used, for example, in the settings of your SBC (Set-CsOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System - -## EXAMPLES - -### Example 1 -```powershell -Set-CsTeamsTranslationRule -Identity StripE164SeattleAreaCode -Pattern ^+12065555(\d{3})$ -Translation $1 -``` - -This example modifies the rule that initially configured to strip +1206555 from any E.164 ten digits number. For example, +12065555555 translated to 5555 to a new pattern. Modified rule now only applies to three digit number (initially to four digits number) and adds one more number in prefix (+120655555 instead of +1206555) - -## PARAMETERS - -### -Identity -Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -A friendly description of the normalization rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -Pattern -A regular expression that caller or callee number must match in order for this rule to be applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Translation -The regular expression pattern that will be applied to the number to convert it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. 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 -``` - -### -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 -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 -[New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) - -[Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) - -[Test-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) - -[Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule +applicable: Microsoft Teams +title: Set-CsTeamsTranslationRule +schema: 2.0.0 +manager: nmurav +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTeamsTranslationRule + +## SYNOPSIS +Cmdlet to modify an existing normalization rule. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTeamsTranslationRule [[-Identity] ] [-Description ] [-Pattern ] [-Translation ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +You can use this cmdlet to modify an existing number manipulation rule. The rule can be used, for example, in the settings of your SBC (Set-CsOnlinePSTNGateway) to convert a callee or caller number to a desired format before entering or leaving Microsoft Phone System + +## EXAMPLES + +### Example 1 +```powershell +Set-CsTeamsTranslationRule -Identity StripE164SeattleAreaCode -Pattern ^+12065555(\d{3})$ -Translation $1 +``` + +This example modifies the rule that initially configured to strip +1206555 from any E.164 ten digits number. For example, +12065555555 translated to 5555 to a new pattern. Modified rule now only applies to three digit number (initially to four digits number) and adds one more number in prefix (+120655555 instead of +1206555) + +## PARAMETERS + +### -Identity +Identifier of the rule. This parameter is required and later used to assign the rule to the Inbound or Outbound Trunk Normalization policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A friendly description of the normalization rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pattern +A regular expression that caller or callee number must match in order for this rule to be applied. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Translation +The regular expression pattern that will be applied to the number to convert it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. 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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Test-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md index 87814ecdff..75ea8483a8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Set-CsTeamsUnassignedNumberTreatment schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Set-CsTeamsUnassignedNumberTreatment @@ -15,11 +16,11 @@ schema: 2.0.0 ## SYNOPSIS Changes a treatment for how calls to an unassigned number range should be routed. The call can be routed to a user, an application or to an announcement service where a custom message will be played to the caller. - ## SYNTAX -```powershell -Set-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Pattern ] [-TargetType ] [-Target ] [-TreatmentPriority ] [-Description ] [-Force] [-Instance ] [-WhatIf] [-Confirm] ] +``` +Set-CsTeamsUnassignedNumberTreatment [[-Identity] ] [-Description ] [-Pattern ] [-Target ] [-TargetType ] + [-TreatmentPriority ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,7 +42,6 @@ Set-CsTeamsUnassignedNumberTreatment -Identity User2PSTN -TargetType User -Targe ``` This example changes the treatment User2PSTN to route the calls to the user user2@contoso.com. - ## PARAMETERS ### -Description @@ -61,20 +61,20 @@ Accept wildcard characters: False ### -Identity The Id of the specific treatment. - ```yaml Type: System.String Parameter Sets: (All) Aliases: Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Pattern -A regular expression that the called number must match in order for the treatment to take effect. It is best pratice to start the regular expression with the hat character and end it with the dollar character. +A regular expression that the called number must match in order for the treatment to take effect. It is best practice to start the regular expression with the hat character and end it with the dollar character. You can use various regular expression test sites on the Internet to validate the expression. ```yaml @@ -130,21 +130,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -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). @@ -165,17 +150,17 @@ To route calls to unassigned Microsoft Calling Plan subscriber numbers, your ten To route calls to unassigned Microsoft Calling Plan service numbers, your tenant needs to have at least one Microsoft Teams Phone Resource Account license. -If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to +If a specified pattern/range contains phone numbers that are assigned to a user or resource account in the tenant, calls to these phone numbers will be routed to the appropriate target and not routed to the specified unassigned number treatment. There are no other checks of the numbers in the range. If the range contains a valid external phone number, outbound calls from Microsoft Teams to that phone number will be routed according to the treatment. ## RELATED LINKS -[Import-CsOnlineAudioFile](https://docs.microsoft.com/powershell/module/skype/import-csonlineaudiofile) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) -[Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) -[Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) -[New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) -[Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +[Test-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md b/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md new file mode 100644 index 0000000000..4567271d50 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsUpdateManagementPolicy.md @@ -0,0 +1,312 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupdatemanagementpolicy +applicable: Microsoft Teams +title: Set-CsTeamsUpdateManagementPolicy +schema: 2.0.0 +author: vargasj-ms +ms.author: vargasj +manager: gnamun +--- + +# Set-CsTeamsUpdateManagementPolicy + +## SYNOPSIS +Use this cmdlet to modify a Teams Update Management policy. + +## SYNTAX + +```powershell +Set-CsTeamsUpdateManagementPolicy + [-DisabledInProductMessages ] + [-Description ] [-AllowManagedUpdates ] [-AllowPreview ] [-UpdateDayOfWeek ] + [-UpdateTime ] [-UpdateTimeOfDay ] [-AllowPublicPreview ] + [-AllowPrivatePreview ] [-UseNewTeamsClient ] + [-BlockLegacyAuthorization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The Teams Update Management Policy allows admins to specify if a given user is enabled to preview features in Teams. + + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsUpdateManagementPolicy -Identity "Campaign Policy" -DisabledInProductMessages @("91382d07-8b89-444c-bbcb-cfe43133af33") +``` + +In this example, the policy "Campaign Policy" is modified, disabling the in-product messages with the category "What's New". + +## 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 +``` + +### -DisabledInProductMessages +List of IDs of the categories of the in-product messages that will be disabled. You can choose one of the categories from this table: + +| ID | Campaign Category | +| -- | -- | +| 91382d07-8b89-444c-bbcb-cfe43133af33 | What's New | +| edf2633e-9827-44de-b34c-8b8b9717e84c | Conferences | + +```yaml +Type: System.Management.Automation.PSListModifier`1[System.String] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowManagedUpdates + +Enables/Disables managed updates for the user. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPreview + +Indicates whether all feature flags are switched on or off. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivatePreview + +This setting will allow admins to allow users in their tenant to opt in to Private Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is Forced, then users will be switched to Private Preview. + +```yaml +Type: AllowPrivatePreview +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPublicPreview + +This setting will allow admins to allow users in their tenant to opt in to Public Preview. + If it is Disabled, then users will not be able to opt in and the ring switcher UI will be hidden in the Desktop Client. + If it is Enabled, then users will be able to opt in and the ring switcher UI will be available in the Desktop Client. + If it is FollowOfficePreview, then users will not be able to opt in and instead follow their Office channel, and be switched to Public Preview if their Office channel is CC (Preview). The ring switcher UI will be hidden in the Desktop Client. This is not applicable to the Web Client. + If it is Forced, then users will be switched to Public Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization + +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. + If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. + If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Enables administrators to provide explanatory text about the policy. For example, the Description might indicate the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateDayOfWeek + + Machine local day. 0-6(Sun-Sat) Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTime + +Machine local time in HH:MM format. Can be set only when AllowManagedUpdates is set to True. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateTimeOfDay + +Machine local time. Can be set only when AllowManagedUpdates is set to True + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseNewTeamsClient + +This setting will enable admins to show or hide which users see the Teams preview toggle on the current Teams client. + If it is AdminDisabled, then users will not be able to see the Teams preview toggle in the Desktop Client. + If it is UserChoice, then users will be able to see the Teams preview toggle in the Desktop Client. + If it is MicrosoftChoice, then Microsoft will configure/ manage whether user sees or does not see this feature if the admin has set nothing. + If it is NewTeamsAsDefault, then New Teams will be default for users, and they will be able to switch back to Classic Teams via the toggle in the Desktop Client. + If it is NewTeamsOnly, then New Teams will be the only Teams client installed for users. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md b/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md new file mode 100644 index 0000000000..001f0dbe19 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsUpgradeConfiguration.md @@ -0,0 +1,196 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsupgradeconfiguration +applicable: Microsoft Teams +title: Set-CsTeamsUpgradeConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsUpgradeConfiguration + +## SYNOPSIS +Administrators can use Set-CsTeamsUpgradeConfiguration to manage certain aspects of client behavior for users being upgraded from Skype for Business to Teams. TeamsUpgradeConfiguration should be used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. + +## SYNTAX + +### Identity (Default) +```powershell +Set-CsTeamsUpgradeConfiguration [-Tenant ] [-DownloadTeams ] [-SfBMeetingJoinUx ] [-BlockLegacyAuthorization ] + [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] +``` + +### Instance +```powershell +Set-CsTeamsUpgradeConfiguration [-Tenant ] [-DownloadTeams ] [-SfBMeetingJoinUx ] [-BlockLegacyAuthorization ] + [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +TeamsUpgradeConfiguration is used in conjunction with TeamsUpgradePolicy. The settings in TeamsUpgradeConfiguration allow administrators to configure whether users subject to upgrade and who are running on Windows clients should automatically download Teams. It allows administrators to determine which application end users should use to join Skype for Business meetings. + +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. + +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: SkypeMeetingsApp and NativeLimitedClient. "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Set-CsTeamsUpgradeConfiguration -DownloadTeams $true -SfBMeetingJoinUx SkypeMeetingsApp +``` + +The above cmdlet specifies that users subject to upgrade should download Teams in the background, and that they should use the Skype For Business Meetings app to join Skype for Business meetings. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DownloadTeams +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` +### -SfBMeetingJoinUx +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +```yaml +Type: string +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: NativeLimitedClient +Accept pipeline input: False +Accept wildcard characters: False +``` +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +For internal use only. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +For internal use only. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +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: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyAuthorization +This setting will force Teams clients to enforce session revocation for core Messaging and Calling/Meeting scenarios. +If turned ON, session revocation will be enforced for calls, chats and meetings for opted-in users. +If turned OFF, session revocation will not be enforced for calls, chats and meetings for opted-in users + +```yaml +Type: Boolean +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 + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES +These settings are only honored by newer versions of Skype for Business clients. + +## RELATED LINKS + +[Get-CsTeamsUpgradeConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradeconfiguration) + +[Get-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsupgradepolicy) + +[Grant-CsTeamsUpgradePolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsupgradepolicy) + +[Migration and interoperability guidance for organizations using Teams together with Skype for Business](https://learn.microsoft.com/MicrosoftTeams/migration-interop-guidance-for-teams-with-skype) diff --git a/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md new file mode 100644 index 0000000000..5c21d8c52c --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsVdiPolicy.md @@ -0,0 +1,165 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-cteamsvdipolicy +title: Set-CsTeamsVdiPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsVdiPolicy + +## SYNOPSIS +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +## SYNTAX + +```powershell +Set-CsTeamsVdiPolicy [-DisableCallsAndMeetings ] [-DisableAudioVideoInCallsAndMeetings ] + [-VDI2Optimization ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. + +The SetCsTeamsVdiPolicy cmdlet allows administrators to update existing Vdi policies that can be assigned to particular users to control Teams features related to Vdi. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity RestrictedUserPolicy -VDI2Optimization "Disabled" +``` + +The command shown in Example 1 uses the Set-CsTeamsVdiPolicy cmdlet to update an existing vdi policy with the Identity RestrictedUserPolicy. This policy will use all the existing values except one: VDI2Optimization; in this example, users with this policy can not be in VDI 2.0 optimized. + +### Example 2 +```powershell +PS C:\> Set-CsTeamsVdiPolicy -Identity OnlyOptimizedPolicy -DisableAudioVideoInCallsAndMeetings $True -DisableCallsAndMeetings $True +``` + +In Example 2, the Set-CsTeamsVdiPolicy cmdlet is used to update a Vdi policy with the Identity OnlyOptimizedPolicy. In this example two different property values are configured: DisableAudioVideoInCallsAndMeetings is set to True and DisableCallsAndMeetings is set to True. All other policy properties will use the existing values. + +## 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 +``` + +### -DisableAudioVideoInCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can hold person-to-person audio and video calls. Set this to TRUE to disallow a non-optimized user to hold person-to-person audio and video calls. Set this to FALSE to allow a non-optimized user to hold person-to-person audio and video calls. A user can still join a meeting and share screen from chat and join a meeting and share a screen and move their audio to a phone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableCallsAndMeetings +Determines whether a user on a non-optimized Vdi environment can make all types of calls. Set this to TRUE to disallow a non-optimized user to make calls, join meetings, and screen share from chat. Set this to FALSE to allow a non-optimized user to make calls, join meetings, and screen share from chat. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Specify the name of the policy being created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VDI2Optimization +Determines whether a user can be VDI 2.0 optimized. +* Enabled - allow a user to be VDI 2.0 optimized. +* Disabled - disallow a user to be VDI 2.0 optimized. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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.Void + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md new file mode 100644 index 0000000000..363ba6ac2f --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy +title: Set-CsTeamsVirtualAppointmentsPolicy +schema: 2.0.0 +author: emmanuelrocha001 +ms.author: erocha +manager: sonaggarwal +--- + +# Set-CsTeamsVirtualAppointmentsPolicy + +## SYNOPSIS +This cmdlet is used to update an instance of TeamsVirtualAppointmentsPolicy. + +## SYNTAX + +``` +Set-CsTeamsVirtualAppointmentsPolicy [-EnableSmsNotifications ] [-Identity] [-Force] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of TeamsVirtualAppointmentsPolicy. + +## EXAMPLES + +### Example 1 + +```powershell +PS> Set-CsTeamsVirtualAppointmentsPolicy -Identity ExistingPolicyInstance -EnableSmsNotifications $false +``` + +Updates the `EnableSmsNotifications` field of a given policy. + +## 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 +``` + +### -EnableSmsNotifications +This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment template meeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) + +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) + +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) + +[Grant-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md index f315ec4f6e..e39d07bd9a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -1,34 +1,72 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/en-us/powershell/module/skype/set-csteamsvoiceapplicationspolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy +title: Set-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 --- # Set-CsTeamsVoiceApplicationsPolicy ## SYNOPSIS + Modifies an existing Teams voice applications policy. ## SYNTAX ``` -Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantAfterHoursGreetingChange ] +Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantBusinessHoursGreetingChange ] - [-AllowAutoAttendantHolidayGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] + [-AllowAutoAttendantAfterHoursGreetingChange ] + [-AllowAutoAttendantHolidayGreetingChange ] + [-AllowAutoAttendantBusinessHoursChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantAfterHoursRoutingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] + [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] - [-AllowCallQueueWelcomeGreetingChange ] [[-Identity] ] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOverflowRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueNoAgentsRoutingChange ] + [-AllowCallQueueAgentOptChange ] + + [-CallQueueAgentMonitorMode ] + [-CallQueueAgentMonitorNotificationMode ] + + [-RealTimeAutoAttendantMetricsPermission ] + [-RealTimeCallQueueMetricsPermission ] + [-RealTimeAgentMetricsPermission ] + + [-HistoricalAutoAttendantMetricsPermission ] + [-HistoricalCallQueueMetricsPermission ] + [-HistoricalAgentMetricsPermission ] + + [[-Identity] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration which allows tenant admins to permit certain users to make changes to auto attendant and call queue configurations. + +`TeamsVoiceApplicationsPolicy` is used for **Supervisor Delegated Administration** which allows admins in the organization to permit certain users to make changes to auto attendant and call queue configurations. ## EXAMPLES ### EXAMPLE 1 -``` + +```powershell Set-CsTeamsVoiceApplicationsPolicy -Identity "SDA-CQ-OverflowGreeting" -AllowCallQueueOverflowSharedVoicemailGreetingChange $true ``` @@ -36,8 +74,9 @@ The command shown in Example 1 sets allowing CQ overflow shared voicemail greeti ## PARAMETERS -### -AllowAutoAttendantAfterHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's after-hours greeting. +### -AllowAutoAttendantBusinessHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours greeting. ```yaml Type: Boolean @@ -51,8 +90,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's business hours greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's business hours greeting. +### -AllowAutoAttendantAfterHoursGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours greeting. ```yaml Type: Boolean @@ -67,7 +107,140 @@ Accept wildcard characters: False ``` ### -AllowAutoAttendantHolidayGreetingChange -When set to True users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to False (the default value) users affected by the policy will not be allowed to change the auto attendant's holiday greeting. + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday greeting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours schedule. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours schedule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidaysChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday schedules. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday schedules. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantTimeZoneChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantBusinessHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's business hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's business hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantAfterHoursRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's after-hours call flow. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's after-hours call flow. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAutoAttendantHolidayRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the auto attendant's holiday call flows. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's holiday call flows. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueWelcomeGreetingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's welcome greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's welcome greeting. ```yaml Type: Boolean @@ -82,7 +255,8 @@ Accept wildcard characters: False ``` ### -AllowCallQueueMusicOnHoldChange -When set to True users affected by the policy will be allowed to change the call queue's music on hold information. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's music on hold. + +When set to `True`, users affected by the policy will be allowed to change the call queue's music on hold information. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's music on hold. ```yaml Type: Boolean @@ -97,7 +271,8 @@ Accept wildcard characters: False ``` ### -AllowCallQueueOverflowSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's overflow shared voicemail greeting. + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow shared voicemail greeting. ```yaml Type: Boolean @@ -112,7 +287,8 @@ Accept wildcard characters: False ``` ### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's timeout shared voicemail greeting. + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout shared voicemail greeting. ```yaml Type: Boolean @@ -126,8 +302,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange -When set to True users affected by the policy will be allowed to change the call queue's welcome greeting. When set to False (the default value) users affected by the policy will not be allowed to change the call queue's welcome greeting. +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml Type: Boolean @@ -141,7 +320,359 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowCallQueueLanguageChange + +_This feature is not currently available to authorized users._ + +When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueMembershipChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's users. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's users. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueConferenceModeChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's conference mode. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's conference mode. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueRoutingMethodChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's routing method. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's routing method. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueuePresenceBasedRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's presence-based routing option. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's presence-based routing option. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOptOutChange + +When set to `True`, users affected by the policy will be allowed to change the call queue opt-out setting that allows agents to opt out of receiving calls. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue opt-out setting. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueOverflowRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's overflow handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's overflow handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueTimeoutRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's timeout handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's timeout handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueNoAgentsRoutingChange + +When set to `True`, users affected by the policy will be allowed to change the call queue's no-agent handling properties. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no-agent handling properties. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallQueueAgentOptChange + +When set to `True`, users affected by the policy will be allowed to change an agent's opt-in status in the call queue. When set to `False` (the default value), users affected by the policy won't be allowed to change an agent's opt-in status in the call queue. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorMode + +PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor call sessions. + +When set to `Monitor`, users affected by the policy will be allowed to monitor and listen to call sessions. + +When set to `Whisper`, users affected by the policy will be allowed to monitor call sessions and whisper to an agent in the call. + +When set to `Barge`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, or join the call session. + +When set to `Takeover`, users affected by the policy will be allowed to monitor call sessions, whisper to an agent in the call, join the call session, or take over the call from an agent. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallQueueAgentMonitorNotificationMode + +PARAMVALUE: Disabled | Agent + +When set to `Disabled` (the default value), users affected by the policy won't be allowed to monitor agents during call sessions. + +When set to `Agent`, users affected by the policy will be allowed to monitor agents during call sessions. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for auto attendants they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RealTimeAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for agents who are members in the call queues they are authorized for. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HistoricalAgentMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All + +When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for agents. + +When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for agents who are members in the call queues they are authorized for. + +When set to `All`, users affected by the policy will receive historical metrics for all agents in all call queues in the organization. + +```yaml +Type: Object +Parameter Sets: Dual +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + Unique identifier assigned to the policy when it was created. Teams voice applications policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: -Identity global @@ -150,7 +681,7 @@ To refer to a per-user policy, use syntax similar to this: -Identity "SDA-Allow-All" -If you do not specify an Identity, then the Set-CsTeamsVoiceApplicationsPolicy cmdlet will modify the global policy. +If you do not specify an Identity, then the `Set-CsTeamsVoiceApplicationsPolicy` cmdlet will modify the global policy. ```yaml Type: String @@ -165,6 +696,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -181,6 +713,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -196,6 +729,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -203,14 +737,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) +[Get-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvoiceapplicationspolicy) -[Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +[Grant-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsvoiceapplicationspolicy) -[Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +[Remove-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvoiceapplicationspolicy) -[New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +[New-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvoiceapplicationspolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md b/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md new file mode 100644 index 0000000000..1db49482a3 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsWorkLoadPolicy.md @@ -0,0 +1,239 @@ +--- +external help file: MicrosoftTeams-help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworkloadpolicy +title: Set-CsTeamsWorkLoadPolicy +schema: 2.0.0 +--- + +# Set-CsTeamsWorkLoadPolicy + +## SYNOPSIS + +This cmdlet sets the Teams Workload Policy value for current tenant. + +## SYNTAX + +```powershell +Set-CsTeamsWorkLoadPolicy [-AllowCalling ] [-AllowCallingPinned ] [-AllowMeeting ] + [-AllowMeetingPinned ] [-AllowMessaging ] [-AllowMessagingPinned ] + [-Description ] [[-Identity] ] [-MsftInternalProcessingMode ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The TeamsWorkLoadPolicy determines the workloads like meeting, messaging, calling that are enabled and/or pinned for the user. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsWorkLoadPolicy -Identity Global -AllowCalling Disabled +``` + +This sets the Teams Workload Policy Global value of AllowCalling to disabled. + +## PARAMETERS + +### -AllowCalling + +Determines if calling workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowCallingPinned + +Determines if calling workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeeting + +Determines if meetings workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMeetingPinned + +Determines if meetings workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessaging + +Determines if messaging workload is enabled in the Teams App. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowMessagingPinned + +Determines if messaging workload is pinned to the teams navigation bar. Possible values are True and False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +The description of the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +The identity of the Teams Work Load Policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MsftInternalProcessingMode + +For internal use only. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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 + +[Remove-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworkloadpolicy) + +[Get-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworkloadpolicy) + +[New-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworkloadpolicy) + +[Grant-CsTeamsWorkLoadPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworkloadpolicy) diff --git a/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md new file mode 100644 index 0000000000..176485db17 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTeamsWorkLocationDetectionPolicy.md @@ -0,0 +1,136 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsworklocationdetectionpolicy +title: Set-CsTeamsWorkLocationDetectionPolicy +schema: 2.0.0 +author: artemiykozlov +ms.author: arkozlov +manager: prashibadkur +--- + +# Set-CsTeamsWorkLocationDetectionPolicy + +## SYNOPSIS +This cmdlet is used to update an instance of TeamsWorkLocationDetectionPolicy. + +## SYNTAX + +``` +Set-CsTeamsWorkLocationDetectionPolicy [-EnableWorkLocationDetection ] [-Identity] [-Force] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates any of the properties of an existing instance of TeamsWorkLocationDetectionPolicy. + +## EXAMPLES + +### Example 1 + +```powershell +PS> Set-CsTeamsWorkLocationDetectionPolicy -Identity ExistingPolicyInstance -EnableWorkLocationDetection $true +``` + +Updates the `EnableWorkLocationDetection` field of a given policy. + +## 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 +``` + +### -EnableWorkLocationDetection +This setting allows your organization to collect the work location of users when they connect, interact, or are detected near your organization's networks and devices. It also captures the geographic location information users share from personal and mobile devices. +This gives users the ability to consent to the use of this location data to set their current work location.Microsoft collects this information to provide users with a consistent location-based experience and to improve the hybrid work experience in Microsoft 365 according to the [Microsoft Privacy Statement](https://go.microsoft.com/fwlink/?LinkId=521839). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Name of the new policy instance to be updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 + +### System.String + +## OUTPUTS + +### System.Void + +## NOTES + +## RELATED LINKS +[Get-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsworklocationdetectionpolicy) + +[New-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsworklocationdetectionpolicy) + +[Remove-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsworklocationdetectionpolicy) + +[Grant-CsTeamsWorkLocationDetectionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsworklocationdetectionpolicy) diff --git a/skype/skype-ps/skype/Set-CsTenantBlockedCallingNumbers.md b/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md similarity index 83% rename from skype/skype-ps/skype/Set-CsTenantBlockedCallingNumbers.md rename to teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md index fb1bcc3f5e..616604a4f9 100644 --- a/skype/skype-ps/skype/Set-CsTenantBlockedCallingNumbers.md +++ b/teams/teams-ps/teams/Set-CsTenantBlockedCallingNumbers.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantblockedcallingnumbers +applicable: Microsoft Teams title: Set-CsTenantBlockedCallingNumbers schema: 2.0.0 +author: serdarsoysal +ms.author: serdars manager: roykuntz -author: jenstrier -ms.author: jenstr --- # Set-CsTenantBlockedCallingNumbers @@ -16,17 +17,25 @@ Use the Set-CsTenantBlockedCallingNumbers cmdlet to set tenant blocked calling n ## SYNTAX ``` -Set-CsTenantBlockedCallingNumbers [-Force] [-Name ] [-WhatIf] [-Confirm] [[-Identity] ] - [-InboundExemptNumberPatterns ] [-Tenant ] [-InboundBlockedNumberPatterns ] - [-Enabled ] [-Instance ] +Set-CsTenantBlockedCallingNumbers [[-Identity] ] + [-Confirm] + [-Enabled ] + [-Force] + [-InboundBlockedNumberPatterns ] + [-InboundExemptNumberPatterns ] + [-Instance ] + [-Name ] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION Microsoft Direct Routing, Operator Connect and Calling Plans supports blocking of inbound calls from the public switched telephone network (PSTN). This feature allows a tenant-global list of number patterns to be defined so that the caller ID of every incoming PSTN call to the tenant can be checked against the list for a match. If a match is made, an incoming call is rejected. -The tenant blocked calling numbers includes a list of inbound blocked number patterns. Number patterns are managed through the CsInboundBlockedNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. +The tenant blocked calling numbers includes a list of inbound blocked number patterns. Number patterns are managed through the CsInboundBlockedNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. -The tenant blocked calling numbers also includes a list of number patterns exempt from call blocking. Exempt number patterns are managed through the CsInboundExemptNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. +The tenant blocked calling numbers also includes a list of number patterns exempt from call blocking. Exempt number patterns are managed through the CsInboundExemptNumberPattern commands New, Get, Set, and Remove. You can manage a given pattern by using these cmdlets, including the ability to toggle the activation of a given pattern. You can test your number blocking by using the Test-CsInboundBlockedNumberPattern command. @@ -41,7 +50,7 @@ To get the current tenant blocked calling numbers setting, use Get-CsTenantBlock Set-CsTenantBlockedCallingNumbers -Enabled $false ``` -This example turns off the tenant blocked calling numbers setting. No inbound number will be blocked from this feature. +This example turns off the tenant blocked calling numbers setting. No inbound number will be blocked from this feature. ### -------------------------- Example 2 -------------------------- ``` @@ -68,6 +77,21 @@ Note that if the current InboundBlockedNumberPatterns already contains a list of ## PARAMETERS +### -Identity +The Identity parameter is a unique identifier which identifies the TenantBlockedCallingNumbers to set. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -113,21 +137,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter is a unique identifier which identifies the TenantBlockedCallingNumbers to set. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InboundBlockedNumberPatterns The InboundBlockedNumberPatterns parameter contains the list of InboundBlockedNumberPatterns. @@ -219,6 +228,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Management.Automation.PSObject @@ -226,9 +238,10 @@ Accept wildcard characters: False ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +[Get-CsTenantBlockedCallingNumbers](https://learn.microsoft.com/powershell/module/teams/get-cstenantblockedcallingnumbers) -[Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +[Test-CsInboundBlockedNumberPattern](https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern) diff --git a/teams/teams-ps/teams/Set-CsTenantDialPlan.md b/teams/teams-ps/teams/Set-CsTenantDialPlan.md new file mode 100644 index 0000000000..1df48b83dc --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantDialPlan.md @@ -0,0 +1,190 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan +applicable: Microsoft Teams +title: Set-CsTenantDialPlan +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTenantDialPlan + +## SYNOPSIS +Use the `Set-CsTenantDialPlan` cmdlet to modify an existing tenant dial plan. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantDialPlan [[-Identity] ] [-Description ] [-NormalizationRules ] + [-SimpleName ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The `Set-CsTenantDialPlan` cmdlet modifies an existing tenant dial plan. A tenant dial plan determines such things as which normalization rules are applied. Tenant dial plans provide required information to let Enterprise Voice users make telephone calls. +The Conferencing Attendant application also uses tenant dial plans for dial-in conferencing. + +## EXAMPLES + +### Example 1 +``` +$nr2 = Get-CsVoiceNormalizationRule -Identity "US/US Long Distance" +Set-CsTenantDialPlan -Identity vt1tenantDialPlan9 -NormalizationRules @{Add=$nr2} +``` + +This example updates the vt1tenantDialPlan9 tenant dial plan to use the US/US Long Distance normalization rules. + +### Example 2 +``` +$DP = Get-CsTenantDialPlan -Identity Global +$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit") +$NR.Name = "RedmondRule" +Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRules +``` + +This example changes the name of a normalization rule. Keep in mind that changing the name also changes the name portion of the Identity. +The `Set-CsVoiceNormalizationRule` cmdlet doesn't have a Name parameter, so in order to change the name, we first call the `Get-CsTenantDialPlan` cmdlet to retrieve the Dial Plan with +the Identity Global and assign the returned object to the variable $DP. Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign the returned object to +the variable $NR. We then assign the string RedmondRule to the Name property of the object. Finally, we pass the variable back to the NormalizationRules parameter of the +`Set-CsTenantDialPlan` cmdlet to make the change permanent. + +### Example 3 +``` +$DP = Get-CsTenantDialPlan -Identity Global +$NR = $DP.NormalizationRules | Where Name -eq "RedmondFourDigit") +$DP.NormalizationRules.Remove($NR) +Set-CsTenantDialPlan -Identity Global -NormalizationRules $DP.NormalizationRules +``` + +This example removes a normalization rule. We utilize the same functionality as for Example 3 to manipulate the Normalization Rule Object and update it with the +`Set-CsTenantDialPlan` cmdlet. We first call the `Get-CsTenantDialPlan` cmdlet to retrieve the Dial Plan with the Identity Global and assign the returned object to the variable $DP. +Then we filter the NormalizationRules Object for the rule RedmondFourDigit and assign it to the variable $NR. Next, we remove this Object with the Remove Method from $DP.NormalizationRules. +Finally, we pass the variable back to the NormalizationRules parameter of the `Set-CsTenantDialPlan` cmdlet to make the change permanent. + +## PARAMETERS + +### -Confirm +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. +Maximum characters is 1040. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NormalizationRules +The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. + +The number of normalization rules cannot exceed 50 per TenantDialPlan. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SimpleName +The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. + +This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), and parentheses (()). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf parameter describes what would happen if you executed the command, without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 +The ExternalAccessPrefix and OptimizeDeviceDialing parameters have been removed from New-CsTenantDialPlan and Set-CsTenantDialPlan cmdlet since they are no longer used. External access dialing is now handled implicitly using normalization rules of the dial plans. +The Get-CsTenantDialPlan will still show the external access prefix in the form of a normalization rule of the dial plan. + +## RELATED LINKS + +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) + +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) + +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md b/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md similarity index 63% rename from skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md rename to teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md index e5c22a88dd..957f463b80 100644 --- a/skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md @@ -1,18 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantfederationconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantfederationconfiguration +applicable: Microsoft Teams title: Set-CsTenantFederationConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney +ms.date: 12/11/2024 --- # Set-CsTenantFederationConfiguration ## SYNOPSIS +> [!NOTE] +> Starting May 5, 2025, Skype Consumer Interoperability with Teams is no longer supported and the parameter AllowPublicUsers can no longer be used. + Manages federation configuration settings for your Skype for Business Online tenants. These settings are used to determine which domains (if any) your users are allowed to communicate with. @@ -20,17 +24,20 @@ These settings are used to determine which domains (if any) your users are allow ### Identity (Default) ``` -Set-CsTenantFederationConfiguration [-Tenant ] [-AllowedDomains ] - [-BlockedDomains ] [-AllowFederatedUsers ] [-AllowPublicUsers ] [-AllowTeamsConsumer ] [-AllowTeamsConsumerInbound ] - [-TreatDiscoveredPartnersAsUnverified ] [-SharedSipAddressSpace ] - [-AllowedDomainsAsAList ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTenantFederationConfiguration [-Tenant ] + [-AllowedDomains ] [-BlockedDomains ] [-BlockAllSubdomains ] + [-AllowFederatedUsers ] [-AllowTeamsConsumer ] [-AllowTeamsConsumerInbound ] + [-TreatDiscoveredPartnersAsUnverified ] [-SharedSipAddressSpace ] [-RestrictTeamsConsumerToExternalUserProfiles ] + [-AllowedDomainsAsAList ] [-ExternalAccessWithTrialTenants ] + [-AllowedTrialTenantDomains ] + [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance ``` Set-CsTenantFederationConfiguration [-Tenant ] [-AllowedDomains ] - [-BlockedDomains ] [-AllowFederatedUsers ] [-AllowPublicUsers ] - [-TreatDiscoveredPartnersAsUnverified ] [-SharedSipAddressSpace ] + [-BlockedDomains ] [-BlockAllSubdomains ] [-AllowFederatedUsers ] + [-TreatDiscoveredPartnersAsUnverified ] [-SharedSipAddressSpace ] [-RestrictTeamsConsumerToExternalUserProfiles ] [-AllowedDomainsAsAList ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -50,14 +57,6 @@ However, administrators must use the `Set-CsTenantPublicProvider` cmdlet in orde ### -------------------------- Example 1 -------------------------- ``` -Set-CsTenantFederationConfiguration -AllowPublicUsers $False -``` - -The command shown in Example 1 disables communication with public providers for the current tenant. - - -### -------------------------- Example 2 -------------------------- -``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" Set-CsTenantFederationConfiguration -BlockedDomains @{Replace=$x} @@ -70,7 +69,6 @@ This domain object is stored in a variable named $x. The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet to update the blocked domains list. Using the Replace method ensures that the existing blocked domains list will be replaced by the new list: a list that contains only the domain fabrikam.com. - ### -------------------------- Example 3 -------------------------- ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -84,7 +82,6 @@ The resulting domain object is then stored in a variable named $x. The second command in the example then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Remove method to remove fabrikam.com from the blocked domains list for the specified tenant. - ### -------------------------- Example 4 -------------------------- ``` $x = New-CsEdgeDomainPattern -Domain "fabrikam.com" @@ -98,7 +95,6 @@ This object is stored in a variable named $x. After the domain object has been created, the second command then uses the `Set-CsTenantFederationConfiguration` cmdlet and the Add method to add fabrikam.com to any domains already on the blocked domains list. - ### -------------------------- Example 5 -------------------------- ``` Set-CsTenantFederationConfiguration -BlockedDomains $Null @@ -120,7 +116,6 @@ Example 6 shows how you can replace domains in the Allowed Domains using a List First, a List collection is created and domains are added to it, then, simply include the AllowedDomainsAsAList parameter and set the parameter value to the List object. When this command completes, the allowed domains list will be replaced with those domains. - ### -------------------------- Example 7 -------------------------- ``` $list = New-Object Collections.Generic.List[String] @@ -150,6 +145,75 @@ Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsume The command shown in Example 9 enables communication with people using Teams with an account that's not managed by an organization, to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people in your organization. +### -------------------------- Example 10 ------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") +Set-CsTenantFederationConfiguration -BlockedDomains $list + +Set-CsTenantFederationConfiguration -BlockAllSubdomains $True +``` + +Example 10 shows how you can block all subdomains of domains in BlockedDomains list. +In this example, all users from contoso.com and fabrikam.com will be blocked. +When the BlockAllSubdomains is enabled, all users from all subdomains of all domains in BlockedDomains list will also be blocked. +So, users from subdomain.contoso.com and subdomain.fabrikam.com will be blocked. +Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain of contoso.com. + +### -------------------------- Example 11 ------------------------- +``` +Set-CsTenantFederationConfiguration -ExternalAccessWithTrialTenants "Allowed" +``` + +Example 11 shows how you can allow users to communicate with users in tenants that contain only trial licenses (default value is Blocked). + +### -------------------------- Example 12 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") +$list.add("fabrikam.com") + +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains $list +``` + +Using the `AllowedTrialTenantDomains` parameter, you can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. Example 12 shows how you can set or replace domains in the Allowed Trial Tenant Domains using a List collection object. +First, a List collection is created and domains are added to it, then, simply include the `AllowedTrialTenantDomains` parameter and set the parameter value to the List object. +When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains. + +### -------------------------- Example 13 -------------------------- +``` +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @("contoso.com", "fabrikam.com") +``` + +Example 13 shows another way to set a value of `AllowedTrialTenantDomains`. It uses array of objects and it always replaces value of the `AllowedTrialTenantDomains`. When this command completes, the result is the same as in example 12. + +The array of `AllowedTrialTenantDomains` can be emptied by running the following command: `Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @()`. + +### -------------------------- Example 14 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") + +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Add=$list} +``` + +Example 14 shows how you can add domains to the existing Allowed Trial Tenant Domains using a List collection object. +First, a List is created and domains are added to it, then, use the Add method in the `AllowedTrialTenantDomains` parameter to add the domains to the existing allowed domains list. +When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list. + +### -------------------------- Example 15 -------------------------- +``` +$list = New-Object Collections.Generic.List[String] +$list.add("contoso.com") + +Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Remove=$list} +``` + +Example 15 shows how you can remove domains from the existing Allowed Trial Tenant Domains using a List collection object. +First, a List is created and domains are added to it, then use the Remove method in the `AllowedTrialTenantDomains` parameter to remove the domains from the existing allowed domains list. +When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list. + ## PARAMETERS ### -AllowedDomains @@ -160,11 +224,13 @@ If the `New-CsEdgeAllowList` cmdlet is used then users can only communicate with Note that string values cannot be passed directly to the AllowedDomains parameter. Instead, you must create an object reference using the `New-CsEdgeAllowList` cmdlet or the `New-CsEdgeAllowAllKnownDomains` cmdlet and then use the object reference variable as the parameter value. +The AllowedDomains parameter can support up to 4,000 domains. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -180,8 +246,8 @@ If this property is set to False then users cannot communicate with users from o ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -190,22 +256,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPublicUsers -When set to True (the default value) users will be potentially allowed to communicate with users who have accounts on public IM and presence providers such as Windows Live, Yahoo, and AOL. -The collection of public providers that users can actually communicate with is managed by using the `Set-CsTenantPublicProvider` cmdlet. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ### -AllowTeamsConsumer Allows federation with people using Teams with an account that's not managed by an organization. @@ -239,11 +289,31 @@ Accept wildcard characters: False ### -BlockedDomains If the AllowedDomains property has been set to AllowAllKnownDomains, then users will be allowed to communicate with users from any domain except domains that appear in the blocked domains list. If the AllowedDomains property has not been set to AllowAllKnownDomains, then the blocked list is ignored, and users can only communicate with domains that have been expressly added to the allowed domains list. +The BlockedDomains parameter can support up to 4,000 domains. ```yaml Type: List Parameter Sets: (All) -Aliases: +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockAllSubdomains +If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking. +If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored. +Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains. +But all subdomains for domains in this list will also be blocked. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Applicable: Skype for Business Online Required: False @@ -260,7 +330,7 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -275,8 +345,8 @@ Suppresses the display of any non-fatal error message that might arise when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -296,8 +366,8 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -312,8 +382,8 @@ Allows you to pass a reference to an object to the cmdlet rather than set indivi ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -329,8 +399,8 @@ The default value is False, meaning that the two sets of users have different SI ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -356,8 +426,8 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -374,8 +444,8 @@ The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -390,8 +460,65 @@ You can specify allowed domains using a List object that contains the domains th ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalAccessWithTrialTenants +When set to 'Blocked', all external access with users from Teams subscriptions that contain only trial licenses will be blocked. This means users from these trial-only tenants will not be able to reach to your users via chats, Teams calls, and meetings (using the users authenticated identity) and your users will not be able to reach users in these trial-only tenants. If this setting is set to "Blocked", users from the trial-only tenant will also be removed from existing chats. + +Allowed - Communication with other tenants is allowed based on other settings. + +Blocked - Communication with users in tenants that contain only trial licenses will be blocked. + +```yaml +Type: ExternalAccessWithTrialTenantsType +Parameter Sets: (All) +Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowedTrialTenantDomains +You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list. + +Note: +- The list supports up to maximum 4k domains. +- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked. +- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored. + +```yaml +Type: List +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictTeamsConsumerToExternalUserProfiles +Defines if a user is restricted to collaboration with Teams Consumer (TFL) user only in Extended Directory. +Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -407,7 +534,7 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -417,16 +544,16 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### +### Input types The `Set-CsTenantFederationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object. ## OUTPUTS -### +### Output types None. Instead, the `Set-CsTenantFederationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object. @@ -434,7 +561,4 @@ Instead, the `Set-CsTenantFederationConfiguration` cmdlet modifies existing inst ## RELATED LINKS -[Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) - -[Get-CsTenantPublicProvider](Get-CsTenantPublicProvider.md) - +[Get-CsTenantFederationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantfederationconfiguration) diff --git a/skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md b/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md similarity index 60% rename from skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md rename to teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md index 688aec5584..9008b4da94 100644 --- a/skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantmigrationconfiguration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration +applicable: Microsoft Teams title: Set-CsTenantMigrationConfiguration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTenantMigrationConfiguration @@ -19,19 +19,29 @@ Used to enable or disable Meeting Migration Service (MMS). ### Identity (Default) ``` -Set-CsTenantMigrationConfiguration [-WhatIf] [-MeetingMigrationEnabled ] [-Confirm] - [[-Identity] ] [-Tenant ] [-Force] [-Instance ] [-AsJob] +Set-CsTenantMigrationConfiguration [[-Identity] ] + [-Confirm] + [-Force] + [-MeetingMigrationEnabled ] + [-Tenant ] + [-WhatIf] + [] ``` ### Instance ``` -Set-CsTenantMigrationConfiguration [-WhatIf] [-MeetingMigrationEnabled ] [-Confirm] -[-Tenant ] [-Force] [-Instance ] [-AsJob] +Set-CsTenantMigrationConfiguration [-Instance ] + [-Confirm] + [-Force] + [-MeetingMigrationEnabled ] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION Used to enable or disable Meeting Migration Service (MMS). -For more information, see [Using the Meeting Migration Service (MMS)](https://docs.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). +For more information, see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). ## EXAMPLES @@ -42,33 +52,33 @@ Set-CsTenantMigrationConfiguration -MeetingMigrationEnabled $false This example disables MMS in the organization. - ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the Migration Configuration. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Type: String +Parameter Sets: Identity +Aliases: +applicable: Microsoft Teams Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Instance +The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. +You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Type: PSObject +Parameter Sets: Instance +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -77,31 +87,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier for the Migration Configuration. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf +applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantMigrationConfiguration` cmdlet. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: PSObject +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -116,8 +125,8 @@ Set this to false to disable the Meeting Migration Service. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -138,8 +147,8 @@ Get-CsTenant | Select-Object DisplayName, TenantID ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -155,26 +164,7 @@ Shows what would happen if the cmdlet runs. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Indicates that this cmdlet runs as a background job. - -When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -184,7 +174,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -193,4 +183,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md new file mode 100644 index 0000000000..7ec40da511 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md @@ -0,0 +1,149 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion +applicable: Microsoft Teams +title: Set-CsTenantNetworkRegion +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +ms.reviewer: +--- + +# Set-CsTenantNetworkRegion + +## SYNOPSIS +As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion to define network regions. A network region interconnects various parts of a network across multiple geographic areas. The RegionID parameter is a logical name that represents the geography of the region and has no dependencies or restrictions. The organization's network region is used for Location-Based Routing. + +## SYNTAX + +### Identity (Default) +``` +Set-CsTenantNetworkRegion [[-Identity] ] [-CentralSite ] [-Description ] + [-NetworkRegionID ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Location-Based Routing leverages the same network regions, sites, and subnets concept that is available in Skype for Business Server. A network region contains a collection of network sites. For example, if your organization has many sites located in Redmond, then you may choose to designate "Redmond" as a network region. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTenantNetworkRegion -Identity "RegionA" -Description "Region A" +``` + +The command shown in Example 1 sets the network region 'RegionA' with the description 'Region A'. + +## PARAMETERS + +### -Identity +Unique identifier for the network region to be set. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CentralSite +This parameter is not used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Provide a description of the network region to identify purpose of setting it. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkRegionID +The name of the network region. Not required in this PowerShell command. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) + +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) + +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) diff --git a/skype/skype-ps/skype/Set-CsTenantNetworkSite.md b/teams/teams-ps/teams/Set-CsTenantNetworkSite.md similarity index 67% rename from skype/skype-ps/skype/Set-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Set-CsTenantNetworkSite.md index e8b54e19c6..9f97f7495e 100644 --- a/skype/skype-ps/skype/Set-CsTenantNetworkSite.md +++ b/teams/teams-ps/teams/Set-CsTenantNetworkSite.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantnetworksite -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite +applicable: Microsoft Teams title: Set-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -19,16 +19,9 @@ As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkSite ### Identity (Default) ```powershell -Set-CsTenantNetworkSite [-Tenant ] [-Description ] [-NetworkRegionID ] - [-LocationPolicy ] [-EnableLocationBasedRouting ] [-OnlineVoiceRoutingPolicy ] - [-NetworkRoamingPolicy ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -```powershell -Set-CsTenantNetworkSite [-Tenant ] [-Description ] [-NetworkRegionID ] - [-LocationPolicy ] [-EnableLocationBasedRouting ] [-OnlineVoiceRoutingPolicy ] - [-NetworkRoamingPolicy ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTenantNetworkSite [[-Identity] ] [-Description ] [-EmergencyCallingPolicy ] [-EmergencyCallRoutingPolicy ] + [-EnableLocationBasedRouting ] [-LocationPolicy ] [-NetworkRegionID ] [-NetworkRoamingPolicy ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,7 +31,7 @@ A best practice for Location Based Routing (LBR) is to create a separate site fo ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Set-CsTenantNetworkSite -Identity "MicrosoftSite1" -NetworkRegionID "RegionRedmond" -Description "Microsoft site 1" ``` @@ -47,14 +40,14 @@ The command shown in Example 1 set the network site 'MicrosoftSite1' with descri The network region 'RegionRedmond' is created beforehand and 'MicrosoftSite1' will be associated with 'RegionRedmond'. -###-------------------------- Example 2 -------------------------- +### Example 2 ```powershell PS C:\> Set-CsTenantNetworkSite -Identity "site2" -Description "site 2" -NetworkRegionID "RedmondRegion" -EnableLocationBasedRouting $true ``` The command shown in Example 2 sets the network site 'site2' with description 'site 2'. This site is enabled for LBR. The example associates the site with network region 'RedmondRegion'. -###-------------------------- Example 3 -------------------------- +### Example 3 ```powershell PS C:\> Set-CsTenantNetworkSite -Identity "site3" -Description "site 3" -NetworkRegionID "RedmondRegion" -NetworkRoamingPolicy "TestNetworkRoamingPolicy" ``` @@ -63,13 +56,13 @@ The command shown in Example 3 sets the network site 'site3' with description 's ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Unique identifier for the network site to be set. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -93,11 +86,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -This parameter determines whether the current site is enabled for location based routing. +### -EmergencyCallingPolicy +This parameter is used to assign a custom emergency calling policy to a network site. For more information, see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -108,11 +101,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -EmergencyCallRoutingPolicy +This parameter is used to assign a custom emergency call routing policy to a network site. For more information, see [Assign a custom emergency call routing policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -123,34 +116,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier for the network site to be set. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantNetworkSite` cmdlet. +### -EnableLocationBasedRouting +This parameter determines whether the current site is enabled for Location-Based Routing. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: Boolean +Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -184,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnlineVoiceRoutingPolicy -This parameter is deprecated and should not be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -NetworkRoamingPolicy NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. @@ -214,19 +176,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network sites are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -236,8 +192,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -252,8 +207,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -262,6 +216,12 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) + +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) + +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) diff --git a/skype/skype-ps/skype/Set-CsTenantNetworkSubnet.md b/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md similarity index 57% rename from skype/skype-ps/skype/Set-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md index ea7ff8bf64..52e3aea595 100644 --- a/skype/skype-ps/skype/Set-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md @@ -1,41 +1,34 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenantnetworksubnet -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet +applicable: Microsoft Teams title: Set-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: tomkau -ms.author: tomkau +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # Set-CsTenantNetworkSubnet ## SYNOPSIS -As an Admin, you can use the Windows PowerShell command, Set-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. Tenant network subnet is used for Location Based Routing. +As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkSubnet to define network subnets and assign them to network sites. Each internal subnet may only be associated with one site. The organization's network subnet is used for Location-Based Routing. ## SYNTAX ### Identity (Default) ``` -Set-CsTenantNetworkSubnet [-Tenant ] [-Description ] [-NetworkSiteID ] - [-MaskBits ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### Instance -``` -Set-CsTenantNetworkSubnet [-Tenant ] [-Description ] [-NetworkSiteID ] - [-MaskBits ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTenantNetworkSubnet [[-Identity] ] [-Description ] + [-MaskBits ] [-NetworkSiteID ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. +IP subnets at the location where Teams endpoints can connect to the network must be defined and associated to a defined network in order to enforce toll bypass. Multiple subnets may be associated with the same network site, but multiple sites may not be associated with a same subnet. This association of subnets enables Location-Based Routing to locate the endpoints geographically to determine if a given PSTN call should be allowed. Both IPv4 and IPv6 subnets are supported. When determining if a Teams endpoint is located at a site an IPv6 address will be checked for a match first. ## EXAMPLES -###-------------------------- Example 1 -------------------------- +### Example 1 ```powershell PS C:\> Set-CsTenantNetworkSubnet -Identity "192.168.0.1" -MaskBits "24" -NetworkSiteID "site1" ``` @@ -44,7 +37,7 @@ The command shown in Example 1 set the network subnet '192.168.0.1'. The subnet IPv4 format subnet accepts maskbits from 0 to 32 inclusive. -###-------------------------- Example 2 -------------------------- +### Example 2 ```powershell PS C:\> Set-CsTenantNetworkSubnet -Identity "2001:4898:e8:25:844e:926f:85ad:dd8e" -MaskBits "120" -NetworkSiteID "site1" -Description "Subnet 2001:4898:e8:25:844e:926f:85ad:dd8e" ``` @@ -55,56 +48,11 @@ IPv6 format subnet accepts maskbits from 0 to 128 inclusive. ## 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 -``` - -### -Description -Provide a description of the network subnet to identify purpose of setting it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity Unique identifier for the network subnet to be set. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: Identity Aliases: @@ -115,19 +63,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -The Instance parameter allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsTenantNetworkSubnet` cmdlet. +### -Description +Provide a description of the network subnet to identify purpose of setting it. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: String +Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -163,19 +110,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose network subnets are being created. For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return your tenant ID by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: System.Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -185,8 +126,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -201,16 +141,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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.Management.Automation.PSObject - ## OUTPUTS -### System.Object ## NOTES ## RELATED LINKS +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) + +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) + +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) diff --git a/skype/skype-ps/skype/Set-CsTenantTrustedIPAddress.md b/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md similarity index 95% rename from skype/skype-ps/skype/Set-CsTenantTrustedIPAddress.md rename to teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md index 6e2745c225..8e93bf341c 100644 --- a/skype/skype-ps/skype/Set-CsTenantTrustedIPAddress.md +++ b/teams/teams-ps/teams/Set-CsTenantTrustedIPAddress.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-cstenanttrustedipaddress -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenanttrustedipaddress +applicable: Microsoft Teams title: Set-CsTenantTrustedIPAddress schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTenantTrustedIPAddress @@ -196,8 +196,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -206,6 +205,7 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-CsUser.md b/teams/teams-ps/teams/Set-CsUser.md new file mode 100644 index 0000000000..97f1298690 --- /dev/null +++ b/teams/teams-ps/teams/Set-CsUser.md @@ -0,0 +1,442 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/set-csuser +applicable: Microsoft Teams +title: Set-CsUser +schema: 2.0.0 +manager: bulenteg +author: tomkau +ms.author: tomkau +ms.reviewer: rogupta +--- + +# Set-CsUser + +## SYNOPSIS +Modifies Skype for Business properties for an existing user account. +Properties can be modified only for accounts that have been enabled for use with Skype for Business. +This cmdlet was introduced in Lync Server 2010. + +**Note**: Using this cmdlet for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. + +## SYNTAX + +``` +Set-CsUser [-DomainController ] [-Identity] [-PassThru] [-WhatIf] [-Confirm] + [-OnPremLineURI ] [-LineServerURI ] [-AudioVideoDisabled ] + [-RemoteCallControlTelephonyEnabled ] [-PrivateLine ] [-AcpInfo ] + [-HostedVoiceMail ] [-EnterpriseVoiceEnabled ] + [-ExchangeArchivingPolicy ] [-LineURI ] [-SipAddress ] + [-Enabled ] [] +``` + +## DESCRIPTION +The `Set-CsUser` cmdlet enables you to modify the Skype for Business related user account attributes that are stored in Active Directory Domain Services or modify a subset of Skype for Business online user attributes that are stored in Microsoft Entra ID. +For example, you can disable or re-enable a user for Skype for Business Server; enable or disable a user for audio/video (A/V) communications; or modify a user's private line and line URI numbers. For Skype for Business online enable or disable a user for enterprise voice, hosted voicemail, or modify the user's on premise line uri. +The `Set-CsUser` cmdlet can be used only for users who have been enabled for Skype for Business. + +The only attributes you can modify using the `Set-CsUser` cmdlet are attributes related to Skype for Business. +Other user account attributes, such as the user's job title or department, cannot be modified by using this cmdlet. +Keep in mind, however, that the Skype for Business attributes should only be modified by using the `Set-CsUser` cmdlet or the Skype for Business Server Control Panel. +You should not attempt to manually configure these attributes. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True +``` + +In Example 1, the `Set-CsUser` cmdlet is used to modify the user account with the Identity Pilar Ackerman. +In this case, the account is modified to enable Enterprise Voice, the Microsoft implementation of VoIP. +This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True. + +### -------------------------- Example 2 -------------------------- +```powershell +Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True +``` + +In Example 2, all the users in the Finance department have their accounts enabled for Enterprise Voice. +In this command, the `Get-CsUser` cmdlet and the LdapFilter parameter are first used to return a collection of all the users who work in the Finance department. +That information is then piped to the `Set-CsUser` cmdlet, which enables Enterprise Voice for each account in the collection. + +### -------------------------- Example 3 -------------------------- +```powershell +Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" +``` + +In Example 3, the `Set-CsUser` cmdlet is used to modify the user account with the Identity Pilar Ackerman. +In this case, the account is modified to set the phone number assigned to the user settings its LineUri property. + +## PARAMETERS + +### -Identity +Indicates the Identity of the user account to be modified. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the display name as the user Identity. +For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AudioVideoDisabled +Indicates whether the user is allowed to make audio/visual (A/V) calls by using Skype for Business. +If set to True, the user will largely be restricted to sending and receiving instant messages. + +You cannot disable A/V communications if a user is currently enabled for remote call control, Enterprise Voice, and/or Internet Protocol private branch exchange (IP-PBX) soft phone routing. + +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Indicates whether or not the user has been enabled for Skype for Business Server. +If you set this value to False, the user will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the user's logon privileges. + +If you disable an account by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the user is enabled for Enterprise Voice and/or remote call control) is retained. +If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. +This differs from using the `Disable-CsUser` cmdlet to disable a user account. +When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data associated with that account is deleted. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: CsEnabled +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Enables you to specify a domain controller to connect to when modifying a user account. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnterpriseVoiceEnabled +Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). +With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedVoiceMail +When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. +In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. + +**Note**: It is not required to set this parameter for Microsoft Teams users. Using this parameter has been deprecated for Microsoft Teams users in commercial and GCC cloud instances. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineURI +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. + +For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. + +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineServerURI +The URI of the remote call control telephone gateway assigned to the user. +The LineServerUri is the gateway URI, prefaced by "sip:". +For example: sip:rccgateway@litwareinc.com + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLine +Phone number for the user's private telephone line. +A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. +In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. +Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. + +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteCallControlTelephonyEnabled +Indicates whether the user has been enabled for remote call control telephony. +When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. +Phone calls can also be made using Skype for Business. +These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). +To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. +For details, see the parameter EnterpriseVoiceEnabled. + +To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SipAddress +Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. +The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Enables you to pass a user object through the pipeline that represents the user whose account is being modified. +By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. + +**Note**: This parameter is not available for Teams Only tenants from version 3.0.0 onwards. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcpInfo +Enables you to assign one or more third-party audio conferencing providers to a user. +However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. + +```yaml +Type: AcpInfo +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeArchivingPolicy +Indicates where the user's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving + +```yaml +Type: ExchangeArchivingPolicyOptionsEnum +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremLineURI +Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. +Depending on your setup, those two numbers could actually be different. +For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. +Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +applicable: Microsoft Teams + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Input types +String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +The `Set-CsUser` cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. +The cmdlet also accepts pipelined instances of the Active Directory user object. + +## OUTPUTS + +### Output types +The `Set-CsUser` cmdlet does not return any objects. + +## NOTES + +## RELATED LINKS + +[Get-CsOnlineUser](https://learn.microsoft.com/powershell/module/teams/get-csonlineuser) diff --git a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md b/teams/teams-ps/teams/Set-CsUserCallingDelegate.md index 39ab6cbb24..ac17aa7a8a 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md +++ b/teams/teams-ps/teams/Set-CsUserCallingDelegate.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-csusercallingdelegate +online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Set-CsUserCallingDelegate schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Set-CsUserCallingDelegate @@ -71,7 +72,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -MakeCalls Specifies whether delegate is allowed to make calls on behalf of the specified user. @@ -137,8 +137,8 @@ The specified user need to have the Microsoft Phone System license assigned. You can see the delegate of a user by using the Get-CsUserCallingSettings cmdlet. ## RELATED LINKS -[Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) -[New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) -[Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/teams/teams-ps/teams/Set-CsUserCallingSettings.md b/teams/teams-ps/teams/Set-CsUserCallingSettings.md index afe45fd31d..4b590f4ab2 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Set-CsUserCallingSettings.md @@ -1,13 +1,14 @@ --- external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-csusercallingsettings +online version: https://learn.microsoft.com/powershell/module/teams/set-csusercallingsettings applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Set-CsUserCallingSettings schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Set-CsUserCallingSettings @@ -60,10 +61,9 @@ Set-CsUserCallingSettings -Identity -GroupNotificationOverride ## DESCRIPTION This cmdlet sets the call forwarding, simultaneous ringing and call group settings for the specified user. -When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to +When specifying settings you need to specify all settings with a settings grouping, for instance, you can't just change a forwarding target. Instead, you need to start by getting the current settings, making the necessary changes, and then setting/writing all settings within the settings group. - ## EXAMPLES ### Example 1 @@ -96,7 +96,7 @@ $cgm = @("sip:user2@contoso.com","sip:user3@contoso.com") Set-CsUserCallingSettings -Identity user1@contoso.com -CallGroupOrder InOrder -CallGroupTargets $cgm Set-CsUserCallingSettings -Identity user1@contoso.com -IsForwardingEnabled $true -ForwardingType Immediate -ForwardingTargetType Group ``` -This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. +This example shows creating a call group for user1@contoso.com with 2 members and setting immediate call forward to the call group for user1@contoso.com. ### Example 6 ```powershell @@ -114,7 +114,7 @@ Set-CsUserCallingSettings -Identity user5@contoso.com -GroupMembershipDetails $g This example shows how to update the call group of user1@contoso.com to add user5@contoso.com and remove user6@contoso.com. In addition the notification setting for user5@contoso.com for user1@contoso.com's call group is set to Banner. -The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, +The key to note here is the call group membership is defined on the object of the owner of the call group, in the above case this is user1@contoso.com. However, the notification setting for a member for a particular call group is defined on the member. In this case user5@contoso.com. ### Example 7 @@ -128,13 +128,13 @@ This example shows how to remove all members of the call group. ### Example 8 ```powershell [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[]]$gmd = @( - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} - [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user20@contoso.com';NotificationSetting='Banner'} + [Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails]@{CallGroupOwnerId='sip:user30@contoso.com';NotificationSetting='Mute'} ) Set-CsUserCallingSettings -Identity user10@contoso.com -GroupMembershipDetails $gmd ``` -In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner +In this example user10@contoso.com is a member of two call groups: user20@contoso.com and user30@contoso.com. User10@contoso.com would like to have Banner notification for the first call group and Mute notification for the last one. ### Example 9 @@ -160,7 +160,6 @@ Set-CsUserCallingSettings -Identity user7@contoso.com -IsUnansweredEnabled $fals This example shows turning off unanswered call forwarding for a user. The Microsoft Teams client will show this as _If unanswered Do nothing_. - ## PARAMETERS ### -CallGroupOrder @@ -219,7 +218,7 @@ Accept wildcard characters: False The forwarding target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. Voicemail is only supported for Immediate forwarding. SingleTarget is used when forwarding to another user or PSTN phone number. MyDelegates is used when forwarding to the users's delegates (there needs to be at least 1 -delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). +delegate). Group is used when forwarding to the user's call group (it needs to have at least 1 member). ```yaml Type: System.String @@ -255,7 +254,7 @@ call group and the notification setting for the specified user for that call gro This parameter only exists if the specified user is a member of a call group. You can't create it, you can only change it. You need to always specify the full group membership details as the parameter value. What you set here will over-write the current group membership details. - + ```yaml Type: Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ICallGroupMembershipDetails[] Parameter Sets: (GroupMembershipDetails) @@ -270,8 +269,8 @@ Accept wildcard characters: False The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. -Setting this overrides the call group notification specified for the individual call group for the specified user. - +The initial setting is shown as Null. It means that the group notification set for the user in the call group is used. If you set GroupNotificationOverride to Mute, that setting will override the group notification for the user in the call group. If you set the GroupNotificationOverride to Ring or Banner, the group notification set for the user in the call group will be used. + ```yaml Type: System.String Parameter Sets: (GroupNotificationOverride) @@ -299,7 +298,7 @@ Accept wildcard characters: False ### -IsForwardingEnabled -This parameter controls whether forwarding is enabled or not. +This parameter controls whether forwarding is enabled or not. ```yaml Type: System.Boolean @@ -314,7 +313,7 @@ Accept wildcard characters: False ### -IsUnansweredEnabled -This parameter controls whether forwarding for unasnwered calls is enabled or not. +This parameter controls whether forwarding for unanswered calls is enabled or not. ```yaml Type: System.Boolean @@ -363,10 +362,10 @@ Accept wildcard characters: False ### -UnansweredTargetType -The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. +The unanswered target type. Supported values are Voicemail, SingleTarget, MyDelegates and Group. -SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's -delegates. Group is used when forwarding the unanswered call to the specified user's call group. +SingleTarget is used when forwarding the unanswered call to another user or phone number. MyDelegates is used when forwarding the unanswered call to the users's +delegates. Group is used when forwarding the unanswered call to the specified user's call group. ```yaml Type: System.String @@ -406,10 +405,10 @@ You can specify a SIP URI without 'sip:' on input, but the output from Get-CsUse You are not able to configure delegates via this cmdlet. Please use New-CsUserCallingDelegate, Set-CsUserCallingDelegate cmdlets and Remove-CsUserCallingDelegate. ## RELATED LINKS -[Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +[Get-CsUserCallingSettings](https://learn.microsoft.com/powershell/module/teams/get-csusercallingsettings) -[New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +[New-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/new-csusercallingdelegate) -[Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +[Set-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/set-csusercallingdelegate) -[Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +[Remove-CsUserCallingDelegate](https://learn.microsoft.com/powershell/module/teams/remove-csusercallingdelegate) diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md b/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md similarity index 85% rename from skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md index 8bc0c0f7e5..87c3b8383b 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md +++ b/teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/set-csvideointeropserviceprovider -applicable: Skype for Business Online -Module Name: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/set-csvideointeropserviceprovider +applicable: Microsoft Teams +Module Name: MicrosoftTeams title: Set-CsVideoInteropServiceProvider schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsVideoInteropServiceProvider @@ -49,7 +49,7 @@ This example enables a VTC device joining anonymously to shown in the meeting as ## PARAMETERS ### -AadApplicationIds -This is an optional parameter. A semicolon separated list of AAD AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. +This is an optional parameter. A semicolon separated list of Microsoft Entra AppIds of the CVI partner bots can be specified in this parameter. This parameter works in conjunction with AllowAppGuestJoinsAsAuthenticated. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of these bots, is shown in the meeting as an authenticated tenant entity. ```yaml Type: String @@ -65,7 +65,7 @@ Accept wildcard characters: False ### -AllowAppGuestJoinsAsAuthenticated This is an optional parameter. Default = false. -This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots AAD application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. +This parameter works in conjunction with AadApplicationIds. When AllowAppGuestJoinsAsAuthenticated is set to true, a VTC device joining anonymously using any of the bots Microsoft Entra application ids specified in AadApplicationIds, is shown in the meeting as an authenticated tenant entity. ```yaml Type: Boolean @@ -201,14 +201,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.Management.Automation.PSObject - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-Team.md b/teams/teams-ps/teams/Set-Team.md index b9735a489b..ec7260f07c 100644 --- a/teams/teams-ps/teams/Set-Team.md +++ b/teams/teams-ps/teams/Set-Team.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-team +online version: https://learn.microsoft.com/powershell/module/teams/set-team +title: Set-Team schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -23,7 +24,7 @@ Set-Team -GroupId [-DisplayName ] [-Description ] [-Mai [-AllowAddRemoveApps ] [-AllowCreateUpdateRemoveTabs ] [-AllowCreateUpdateRemoveConnectors ] [-AllowUserEditMessages ] [-AllowUserDeleteMessages ] [-AllowOwnerDeleteMessages ] [-AllowTeamMentions ] - [-AllowChannelMentions ] [-ShowInTeamsSearchAndSuggestions ] [] + [-AllowChannelMentions ] [-ShowInTeamsSearchAndSuggestions ] [-AllowCreatePrivateChannels ] [] ``` ## DESCRIPTION @@ -388,9 +389,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowCreatePrivateChannels +Determines whether private channel creation is allowed for the team. + +```yaml +Type: Boolean +Parameter Sets: CreateTeam +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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -400,7 +415,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Get-Team]() - -[New-Team]() +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) +[New-Team](https://learn.microsoft.com/powershell/module/teams/new-team) diff --git a/teams/teams-ps/teams/Set-TeamArchivedState.md b/teams/teams-ps/teams/Set-TeamArchivedState.md index 18b398b0c6..5b3b53ee89 100644 --- a/teams/teams-ps/teams/Set-TeamArchivedState.md +++ b/teams/teams-ps/teams/Set-TeamArchivedState.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml -Module Name: microsoftteams -online version: https://docs.microsoft.com/powershell/module/teams/set-teamarchivedstate +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-teamarchivedstate +title: Set-TeamArchivedState schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -38,7 +39,7 @@ This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as arch PS C:\> Set-TeamArchivedState -GroupId 105b16e2-dc55-4f37-a922-97551e9e862d -Archived:$true -SetSpoSiteReadOnlyForMembers:$true ``` -This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members. +This example sets the group with id 105b16e2-dc55-4f37-a922-97551e9e862d as archived and makes the SharePoint site read-only for team members. ### Example 3 ```powershell @@ -104,6 +105,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/teams/teams-ps/teams/Set-TeamChannel.md b/teams/teams-ps/teams/Set-TeamChannel.md index 961a1bfb45..14b6fa83e6 100644 --- a/teams/teams-ps/teams/Set-TeamChannel.md +++ b/teams/teams-ps/teams/Set-TeamChannel.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-teamchannel +online version: https://learn.microsoft.com/powershell/module/teams/set-teamchannel +title: Set-TeamChannel schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -24,7 +25,7 @@ Set-TeamChannel -GroupId -CurrentDisplayName [-NewDisplayName ## DESCRIPTION > [!IMPORTANT] -> Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here . +> Modules in the PS INT gallery for Microsoft Teams run on the /beta version in Microsoft Graph and are subject to change. Int modules can be install from here `https://www.poshtestgallery.com/packages/MicrosoftTeams`. ## EXAMPLES @@ -99,8 +100,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Set-TeamFunSettings.md b/teams/teams-ps/teams/Set-TeamFunSettings.md index ba7424fb44..b0c4f9d5ab 100644 --- a/teams/teams-ps/teams/Set-TeamFunSettings.md +++ b/teams/teams-ps/teams/Set-TeamFunSettings.md @@ -3,7 +3,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamFunSettings -online version: https://docs.microsoft.com/powershell/module/teams/set-teamfunsettings +online version: https://learn.microsoft.com/powershell/module/teams/set-teamfunsettings schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -127,4 +127,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamGuestSettings.md b/teams/teams-ps/teams/Set-TeamGuestSettings.md index 2af67adb8a..97674abb46 100644 --- a/teams/teams-ps/teams/Set-TeamGuestSettings.md +++ b/teams/teams-ps/teams/Set-TeamGuestSettings.md @@ -3,7 +3,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamGuestSettings -online version: https://docs.microsoft.com/powershell/module/teams/set-teamguestsettings +online version: https://learn.microsoft.com/powershell/module/teams/set-teamguestsettings schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -95,4 +95,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamMemberSettings.md b/teams/teams-ps/teams/Set-TeamMemberSettings.md index f3afcac87d..0e21dfe1c8 100644 --- a/teams/teams-ps/teams/Set-TeamMemberSettings.md +++ b/teams/teams-ps/teams/Set-TeamMemberSettings.md @@ -3,7 +3,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamMemberSettings -online version: https://docs.microsoft.com/powershell/module/teams/set-teammembersettings +online version: https://learn.microsoft.com/powershell/module/teams/set-teammembersettings schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -156,4 +156,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamMessagingSettings.md b/teams/teams-ps/teams/Set-TeamMessagingSettings.md index 5a3f610f69..eebbf86afa 100644 --- a/teams/teams-ps/teams/Set-TeamMessagingSettings.md +++ b/teams/teams-ps/teams/Set-TeamMessagingSettings.md @@ -3,7 +3,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams applicable: Microsoft Teams title: Set-TeamMessagingSettings -online version: https://docs.microsoft.com/powershell/module/teams/set-teammessagingsettings +online version: https://learn.microsoft.com/powershell/module/teams/set-teammessagingsettings schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -158,4 +158,3 @@ Accept wildcard characters: False ## NOTES ## RELATED LINKS - diff --git a/teams/teams-ps/teams/Set-TeamPicture.md b/teams/teams-ps/teams/Set-TeamPicture.md index b52f2e4cfb..eeb537153b 100644 --- a/teams/teams-ps/teams/Set-TeamPicture.md +++ b/teams/teams-ps/teams/Set-TeamPicture.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-teampicture +online version: https://learn.microsoft.com/powershell/module/teams/set-teampicture +title: Set-TeamPicture schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -14,8 +15,8 @@ ms.reviewer: Update the team picture. -Note: the command will return immediately, but the Teams application will not reflect the update immediately. -The Teams application may need to be open for up to an hour before changes are reflected. +Note: the command will return immediately, but the Teams application will not reflect the update immediately. +The Teams application may need to be open for up to an hour before changes are reflected. Note: this cmdlet is not support in special government environments (TeamsGCCH and TeamsDoD) and is currently only supported in our beta release. @@ -67,8 +68,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md b/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md index 2d8c709676..4f8a952534 100644 --- a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md +++ b/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/connect-microsoftteams +online version: https://learn.microsoft.com/powershell/module/teams/connect-microsoftteams +title: Set-TeamTargetingHierarchy schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -17,7 +18,7 @@ Upload a hierarchy to the tenant. A tenant may only have 1 active hierarchy. Eac ### Get (Default) ``` -Set-TeamTargetingHierarchyStatus [-FilePath ] +Set-TeamTargetingHierarchyStatus [-FilePath ] [-ApiVersion ] [] ``` ## DESCRIPTION @@ -31,15 +32,14 @@ Based on the CSV file, the following hierarchy is created: - Apogee -    New Jersey -       Basking Ridge --       Moutain Lakes +-       Mountain Lakes ## EXAMPLES ### Example 1 ```powershell PS C:\> Set-TeamTargetingHierarchy -FilePath d:\hier.csv -``` -```output + Key Value --- ----- requestId c67e86109d88479e9708c3b7e8ff7217 @@ -61,10 +61,33 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### -ApiVersion +The version of the Hierarchy APIs to use. Valid values are: 1 or 2. + +Currently only available in preview from version 6.6.1-preview. Specifying "-ApiVersion 2" will direct cmdlet requests to the newer version of the Hierarchy APIs. This integration is currently in preview/beta mode so customers should not try it on their production workloads but are welcome to try it on test workloads. This is an optional parameter and not specifying it will be interpreted as specifying "-ApiVersion 1", which will continue to direct cmdlet requests to the original version of the Hierarchy APIs until we upgrade production to v2, at which time we will set the default to 2. We do not expect this to have any impact on your cmdlet usage or existing scripts. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 1 +Accept pipeline input: false +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES ## RELATED LINKS -[Get-TeamTargetingHierarchyStatus](https://docs.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus) +[Get-TeamTargetingHierarchyStatus](https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus) diff --git a/teams/teams-ps/teams/Set-TeamsApp.md b/teams/teams-ps/teams/Set-TeamsApp.md index 3b9e4c77f6..3f493249cb 100644 --- a/teams/teams-ps/teams/Set-TeamsApp.md +++ b/teams/teams-ps/teams/Set-TeamsApp.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/set-teamsapp +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsapp +title: Set-TeamsApp schema: 2.0.0 --- @@ -59,14 +60,12 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None - ## OUTPUTS ### System.Object diff --git a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md new file mode 100644 index 0000000000..81c1a3382e --- /dev/null +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig +title: Set-TeamsEnvironmentConfig +schema: 2.0.0 +author: VikneshMSFT +ms.author: vimohan +ms.reviewer: pbafna +manager: vinelap +--- + +# Set-TeamsEnvironmentConfig + +## SYNOPSIS + +Sets environment-specific configurations on the local machine and is used to connect to the right environment when running Connect-MicrosoftTeams. + +## SYNTAX + +``` +Set-TeamsEnvironmentConfig [-EndpointUris ] [-TeamsEnvironmentName ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This cmdlet sets environment-specific configurations like endpoint URIs(such as Microsoft Entra ID and Microsoft Graph) and Teams environment (such as GCCH and DOD) on the local machine. + +When running Connect-MicrosoftTeams, environment-specific information set in this cmdlet will be considered unless overridden by Connect-MicrosoftTeams parameters. + +Parameters passed to Connect-MicrosoftTeams will take precedence over the information set by this cmdlet. + +Clear-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina +``` + +Sets the environment as Gallatin China on a local machine and when Connect-MicrosoftTeams is run, authentication will happen in the Gallatin China cloud and Microsoft Teams module will connect to the Gallatin environment. + +### Example 2 +```powershell +$endPointUriDict = @{ActiveDirectory = 'https://login.microsoftonline.us/';MsGraphEndpointResourceId = 'https://graph.microsoft.us/'} +Set-TeamsEnvironmentConfig -TeamsEnvironmentName $endPointUriDict +``` +Sets endpoint URIs required for special clouds. + +### Example 3 +```powershell +Set-TeamsEnvironmentConfig -TeamsEnvironmentName TeamsChina + +$cred=get-credential +Move-CsUser -Identity "PilarA@contoso.com" -Target "sipfed.online.lync.com" -Credential $cred +``` +This cmdlet is mainly introduced to support Skype for Business to Microsoft Teams user migration using Move-CsUser. + +This example shows how tenant admins can run Move-CsUser in Gallatin and other special clouds after setting the environment configuration using Set-TeamsEnvironmentConfig. + +Note that Set-TeamsEnvironmentConfig needs to be run only once for each machine. There is no need to run it each time before running Move-CsUser. + +## 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 +``` + +### -EndpointUris +Provides custom endpoints. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEnvironmentName +Provides a Teams environment to connect to, for example, Teams GCCH or Teams DoD. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +Set-TeamsEnvironmentConfig should not be used in Commercial, GCC, GCC High, or DoD environments. + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Start-CsExMeetingMigration.md b/teams/teams-ps/teams/Start-CsExMeetingMigration.md similarity index 59% rename from skype/skype-ps/skype/Start-CsExMeetingMigration.md rename to teams/teams-ps/teams/Start-CsExMeetingMigration.md index 44868ed23a..411d082929 100644 --- a/skype/skype-ps/skype/Start-CsExMeetingMigration.md +++ b/teams/teams-ps/teams/Start-CsExMeetingMigration.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/start-csexmeetingmigration -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/start-csexmeetingmigration +applicable: Microsoft Teams title: Start-CsExMeetingMigration schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Start-CsExMeetingMigration @@ -18,15 +18,14 @@ This cmdlet manually trigger a meeting migration request for the specified user. ## SYNTAX ``` -Start-CsExMeetingMigration [-SourceMeetingType ] [-TargetMeetingType ] - [-Tenant ] [-Identity] [-WhatIf] [-Confirm] [] +Start-CsExMeetingMigration [-SourceMeetingType ] [-TargetMeetingType ] [-Identity] [] ``` ## DESCRIPTION Meeting Migration Service (MMS) is a Skype for Business service that runs in the background and automatically updates Skype for Business and Microsoft Teams meetings for users. MMS is designed to eliminate the need for users to run the Meeting Migration Tool to update their Skype for Business and Microsoft Teams meetings. -Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migration manually. +Also, with `Start-CsExMeetingMigration` cmdlet, you can start a meeting migration manually. For more information about requirements of the Meeting Migration Service (MMS), see [Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). ## EXAMPLES @@ -37,12 +36,11 @@ Start-CsExMeetingMigration -Identity ashaw@contoso.com -TargetMeetingType Teams This example below shows how to initiate meeting migration for user ashaw@contoso.com so that all meetings are migrated to Teams. - ## PARAMETERS ### -Identity -Specifies the Identity of the user account to be modified. A user identity can be specified by using one of four formats: -1. The user's SIP address +Specifies the Identity of the user account to be modified. A user identity can be specified by using one of four formats: +1. The user's SIP address 2. The user's user principal name (UPN) 3. The user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) 4. The user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. @@ -50,8 +48,8 @@ Specifies the Identity of the user account to be modified. A user identity can b ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -60,54 +58,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SourceMeetingType The possible values are: * **All:** indicates that both Skype for Business meetings and Teams meetings should be updated. This is the **default value**. @@ -118,7 +68,7 @@ The possible values are: Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -136,7 +86,7 @@ The possible values are: Type: Object Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -146,7 +96,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -155,13 +105,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Using the Meeting Migration Service (MMS)](https://docs.microsoft.com/SkypeForBusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) - -[Get-CsMeetingMigrationStatus](https://docs.microsoft.com/powershell/module/skype/get-csmeetingmigrationstatus) - -[Set-CsTenantMigrationConfiguration](https://docs.microsoft.com/powershell/module/skype/set-cstenantmigrationconfiguration) - -[Get-CsTenantMigrationConfiguration](https://docs.microsoft.com/powershell/module/skype/get-cstenantmigrationconfiguration) +[Using the Meeting Migration Service (MMS)](https://learn.microsoft.com/SkypeForBusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms) +[Get-CsMeetingMigrationStatus](https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) diff --git a/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md new file mode 100644 index 0000000000..8076e411c3 --- /dev/null +++ b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md @@ -0,0 +1,169 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance +applicable: Microsoft Teams +title: Sync-CsOnlineApplicationInstance +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +manager: naveenv +ms.reviewer: +--- + +# Sync-CsOnlineApplicationInstance + +## SYNOPSIS +Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. + +## SYNTAX + +``` +Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Force] [-ApplicationId ] [-AcsResourceId ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Microsoft Entra ID into Agent Provisioning Service. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +```powershell +Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +``` + +This example sync application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" and application ID "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" into Agent Provisioning Service. + +### -------------------------- Example 2 -------------------------- +```powershell +Sync-CsOnlineApplicationInstance -ObjectId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ApplicationId 00000000-0000-0000-0000-000000000000 +``` +This command is helpful when there's already a mapping in Agent Provisioning Service and you want to set a different app ID value. In this case, when running the cmdlet in example 1, you will see `Sync-CsOnlineApplicationInstance : An item with the same key has already been added.`. + +The command removes the mapping for application instance with object ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". Run the example cmdlet again to create the mapping in Agent Provisioning Service. + +## PARAMETERS + +### -CallbackUri +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The application instance ID. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplicationId +The application ID. The Microsoft application Auto Attendant has the ApplicationId ce933385-9390-45d1-9512-c8d228074e07 and the Microsoft application Call Queue has the ApplicationId 11cd3e2e-fccb-42ad-ad00-878b93575e07. Third-party applications available in a tenant will use other ApplicationId's. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +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 +``` + +### -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 +``` + +### CommonParameters +This cmdlet supports the common parameters: `-Debug, -ErrorAction, -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 + +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) + +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) + +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) + +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) diff --git a/skype/skype-ps/skype/Test-CsEffectiveTenantDialPlan.md b/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md similarity index 85% rename from skype/skype-ps/skype/Test-CsEffectiveTenantDialPlan.md rename to teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md index cc6c339ff6..1402626383 100644 --- a/skype/skype-ps/skype/Test-CsEffectiveTenantDialPlan.md +++ b/teams/teams-ps/teams/Test-CsEffectiveTenantDialPlan.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-cseffectivetenantdialplan -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-cseffectivetenantdialplan +applicable: Microsoft Teams title: Test-CsEffectiveTenantDialPlan schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Test-CsEffectiveTenantDialPlan @@ -39,8 +39,7 @@ The `Test-CsEffectiveTenantDialPlan` cmdlet normalizes the dialed number by appl Get-CsEffectiveTenantDialPlan -Identity adelev | Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 ``` -This example gets the Identity of a dial plan that is associated with the identity of an user, and applies the retrieved tenant dial plan to normalize the dialed number. - +This example gets the Identity of a dial plan that is associated with the identity of a user, and applies the retrieved tenant dial plan to normalize the dialed number. ### -------------------------- Example 2 -------------------------- ``` @@ -49,7 +48,6 @@ Test-CsEffectiveTenantDialPlan -DialedNumber 14258828080 -Identity adelev@contos This example tests the given dialed number against a specific identity. - ## PARAMETERS ### -DialedNumber @@ -58,8 +56,8 @@ The DialedNumber parameter is the phone number to be normalized with the effecti ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -74,8 +72,8 @@ Indicates the identity of the user account to be tested against. The user's SIP ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -91,7 +89,7 @@ The Confirm switch causes the command to pause processing, and requires confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -108,8 +106,8 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -126,7 +124,7 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -141,8 +139,8 @@ The EffectiveTenantDialPlanName parameter is the effective tenant dial plan name ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -157,8 +155,8 @@ Runs the test only against Tenant-level dial plans (does not take into account S ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -168,7 +166,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -177,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Test-CsInboundBlockedNumberPattern.md b/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md similarity index 83% rename from skype/skype-ps/skype/Test-CsInboundBlockedNumberPattern.md rename to teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md index 5b27290072..56da11fbfd 100644 --- a/skype/skype-ps/skype/Test-CsInboundBlockedNumberPattern.md +++ b/teams/teams-ps/teams/Test-CsInboundBlockedNumberPattern.md @@ -1,114 +1,113 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csinboundblockednumberpattern -applicable: Skype for Business Online -title: Test-CsInboundBlockedNumberPattern -author: tomkau -ms.author: tomkau -ms.reviewer: -manager: bulenteg -schema: 2.0.0 ---- - -# Test-CsInboundBlockedNumberPattern - -## SYNOPSIS -This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. - -## SYNTAX - -``` -Test-CsInboundBlockedNumberPattern -PhoneNumber [-TenantId ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Test-CsInboundBlockedNumberPattern -PhoneNumber "321321321" -``` - -Tests the "321321321" number to check if it will be blocked for inbound calls. - -## 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 -``` - -### -PhoneNumber -The phone number to be tested. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TenantId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -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 (https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -### System.Guid - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-csinboundblockednumberpattern +applicable: Microsoft Teams +title: Test-CsInboundBlockedNumberPattern +author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney +--- + +# Test-CsInboundBlockedNumberPattern + +## SYNOPSIS +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +## SYNTAX + +``` +Test-CsInboundBlockedNumberPattern -PhoneNumber [-TenantId ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet tests the given number against the created (by using New-CsInboundBlockedNumberPattern cmdlet) blocked numbers pattern. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Test-CsInboundBlockedNumberPattern -PhoneNumber "321321321" +``` + +Tests the "321321321" number to check if it will be blocked for inbound calls. + +## 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 +``` + +### -PhoneNumber +The phone number to be tested. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TenantId +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +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](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +### System.Guid + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md b/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md index 1e86237b8b..7d7fd3966d 100644 --- a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md +++ b/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md @@ -5,7 +5,7 @@ title: Test-CsTeamsShiftsConnectionValidate author: gucsun ms.author: gucsun manager: navinth -online version: https://docs.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate +online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate schema: 2.0.0 --- @@ -18,12 +18,12 @@ This cmdlet validates workforce management (WFM) connection settings. ## SYNTAX ``` -Test-CsTeamsShiftsConnectionValidate -ConnectorId -ConnectorSpecificSettingAdminApiUrl -ConnectorSpecificSettingCookieAuthUrl -ConnectorSpecificSettingEssApiUrl -ConnectorSpecificSettingFederatedAuthUrl -ConnectorSpecificSettingLoginPwd -ConnectorSpecificSettingLoginUserName -ConnectorSpecificSettingRetailWebApiUrl -ConnectorSpecificSettingSiteManagerUrl -Name [] +Test-CsTeamsShiftsConnectionValidate -ConnectorId -ConnectorSpecificSettings -Name [] ``` ## DESCRIPTION -This cmdlet validates Workforce management (WFM) connection settings. It validates that the provided WFM account/password and required endpoints are set correctly. +This cmdlet validates Workforce management (WFM) connection settings. It validates that the provided WFM account/password and required endpoints are set correctly. ## EXAMPLES @@ -32,7 +32,17 @@ This cmdlet validates Workforce management (WFM) connection settings. It validat PS C:\> $InstanceName = "test instance name" PS C:\> $WfmUserName = "WfmUserName" PS C:\> $plainPwd = "plainPwd" -PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E9CD74" -ConnectorSpecificSettingAdminApiUrl "https://nehstdevwfm02.contoso.com/retail/data/wfmadmin/api/v1-beta2" -ConnectorSpecificSettingCookieAuthUrl "https://nehstdevwfm02.contoso.com/retail/data/login" -ConnectorSpecificSettingEssApiUrl "https://nehstdevfas01.contoso.com/retail/data/wfmess/api/v1-beta1" -ConnectorSpecificSettingFederatedAuthUrl "https://nehstdevfas01.contoso.com/retail/data/login" -ConnectorSpecificSettingLoginPwd $plainPwd -ConnectorSpecificSettingLoginUserName $WfmUserName -ConnectorSpecificSettingRetailWebApiUrl "https://nehstdevwfm02.contoso.com/retail/data/retailwebapi/api/v1" -ConnectorSpecificSettingSiteManagerUrl "https://nehstdevfas01.contoso.com/retail/data/wfmsm/api/v1-beta2" -Name $InstanceName +PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificBlueYonderSettingsRequest -Property @{ AdminApiUrl = "https://contoso.com/retail/data/wfmadmin/api/v1-beta3"; SiteManagerUrl = "https://contoso.com/retail/data/wfmsm/api/v1-beta4"; EssApiUrl = "https://contoso.com/retail/data/wfmess/api/v1-beta2"; RetailWebApiUrl = "https://contoso.com/retail/data/retailwebapi/api/v1"; CookieAuthUrl = "https://contoso.com/retail/data/login"; FederatedAuthUrl = "https://contoso.com/retail/data/login"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName +``` + +Returns the list of conflicts if there are any. Empty result means there's no conflict. + +### Example 2 +```powershell +PS C:\> $InstanceName = "test instance name" +PS C:\> $WfmUserName = "WfmUserName" +PS C:\> $plainPwd = "plainPwd" +PS C:\> Test-CsTeamsShiftsConnectionValidate -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest -Property @{ apiUrl = "https://contoso.com/api"; ssoUrl = "https://contoso.com/sso"; appKey = "myAppKey"; clientId = "myClientId"; clientSecret = "PlaceholderForClientSecret"; LoginUserName = "PlaceholderForUsername"; LoginPwd = "PlaceholderForPassword" }) -Name $InstanceName ``` Returns the list of conflicts if there are any. Empty result means there's no conflict. @@ -71,127 +81,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettingLoginUserName - -The login user name to the WFM team. +### -ConnectorSpecificSettings +The connector specific settings. ```yaml -Type: String -Parameter Sets: (All) +Type: IConnectorInstanceRequestConnectorSpecificSettings +Parameter Sets: NewExpanded Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -ConnectorSpecificSettingLoginPwd - -The login password to the WFM team. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSpecificSettingAdminApiUrl - -The admin API URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSpecificSettingCookieAuthUrl - -The cookie authorization URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSpecificSettingEssApiUrl - -The essential API URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSpecificSettingFederatedAuthUrl - -The federated authorization URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSpecificSettingRetailWebApiUrl - -The retail web API URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectorSpecificSettingSiteManagerUrl - -The site manager URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams Required: True Position: Named Default value: None @@ -210,6 +107,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) diff --git a/skype/skype-ps/skype/Test-CsTeamsTranslationRule.md b/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md similarity index 75% rename from skype/skype-ps/skype/Test-CsTeamsTranslationRule.md rename to teams/teams-ps/teams/Test-CsTeamsTranslationRule.md index c64b04aa95..42891b66a8 100644 --- a/skype/skype-ps/skype/Test-CsTeamsTranslationRule.md +++ b/teams/teams-ps/teams/Test-CsTeamsTranslationRule.md @@ -1,84 +1,84 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/test-csteamstranslationrule -applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: -schema: 2.0.0 ---- - -# Test-CsTeamsTranslationRule - -## SYNOPSIS -This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. - -## SYNTAX - -### Test (Default) -```powershell -Test-CsTeamsTranslationRule [-PhoneNumber ] [] -``` - -## DESCRIPTION -This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. - - -## EXAMPLES - -### Example 1 -```powershell -Test-CsTeamsTranslationRule -PhoneNumber 1234 -``` -```output -Identity Pattern PhoneNumberTranslated Translation --------- ------- --------------------- ----------- -rule1 ^1234$ 4321 4321 -``` -This example displays information about the manipulation rule matching the phone number 1234. - -## PARAMETERS - -### -PhoneNumber -The phone number to test. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 - -### None - -## NOTES -The cmdlet is available in Teams PowerShell Module 4.5.0 or later. - -The matching logic used in the cmdlet is the same as when the manipulation rule has been associated with an SBC and a call is being routed. - -If a match is found in two or more manipulation rules, the first one is returned. - -There is a short delay before newly created manipulation rules are added to the evaluation. - -## RELATED LINKS -[New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) - -[Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) - -[Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) - -[Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-csteamstranslationrule +applicable: Microsoft Teams +title: Test-CsTeamsTranslationRule +schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: +--- + +# Test-CsTeamsTranslationRule + +## SYNOPSIS +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +## SYNTAX + +### Test (Default) +```powershell +Test-CsTeamsTranslationRule [-PhoneNumber ] [] +``` + +## DESCRIPTION +This cmdlet tests a phone number against the configured number manipulation rules and returns information about the matching rule. + +## EXAMPLES + +### Example 1 +```powershell +Test-CsTeamsTranslationRule -PhoneNumber 1234 +``` +```output +Identity Pattern PhoneNumberTranslated Translation +-------- ------- --------------------- ----------- +rule1 ^1234$ 4321 4321 +``` +This example displays information about the manipulation rule matching the phone number 1234. + +## PARAMETERS + +### -PhoneNumber +The phone number to test. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 + +### None + +## NOTES +The cmdlet is available in Teams PowerShell Module 4.5.0 or later. + +The matching logic used in the cmdlet is the same as when the manipulation rule has been associated with an SBC and a call is being routed. + +If a match is found in two or more manipulation rules, the first one is returned. + +There is a short delay before newly created manipulation rules are added to the evaluation. + +## RELATED LINKS +[New-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/new-csteamstranslationrule) + +[Get-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/get-csteamstranslationrule) + +[Set-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/set-csteamstranslationrule) + +[Remove-CsTeamsTranslationRule](https://learn.microsoft.com/powershell/module/teams/remove-csteamstranslationrule) diff --git a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md b/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md index c1c430571e..1682ef0ba6 100644 --- a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.TeamsCmdlets.Powershell.Custom.dll-Help.xml -online version: https://docs.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment -Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/test-csteamsunassignednumbertreatment +Module Name: Microsoft Teams title: Test-CsTeamsUnassignedNumberTreatment author: firatakandere ms.author: osakande @@ -16,12 +16,11 @@ This cmdlet tests the given number against the created (by using New-CsTeamsUnas ## SYNTAX ``` -Test-CsTeamsUnassignedNumberTreatment -PhoneNumber [-TenantId ] [-WhatIf] -[-Confirm] [] +Test-CsTeamsUnassignedNumberTreatment -PhoneNumber [] ``` ## DESCRIPTION -This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. +This cmdlet tests the given number against the created (by using New-CsTeamsUnassignedNumberTreatment cmdlet) unassigned number treatment configurations. If a match is found, the matching treatment is displayed. ## EXAMPLES @@ -34,21 +33,6 @@ Tests the "321321321" number to check if there is a matching unassigned number t ## 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 -``` - ### -PhoneNumber The phone number to be tested. @@ -64,37 +48,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -TenantId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Names -Default value: None -Accept pipeline input: True (ByPropertyName) -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](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -102,8 +55,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String -### System.Guid - ## OUTPUTS ### System.Object @@ -113,4 +64,10 @@ The cmdlet is available in Teams PS module 3.2.0-preview or later. ## RELATED LINKS -[New-CsTeamsUnassignedNumberTreatment](/powershell/module/teams/new-csteamsunassignednumbertreatment?view=teams-ps) \ No newline at end of file +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) + +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) + +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) + +[Remove-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/remove-csteamsunassignednumbertreatment) diff --git a/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md b/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md new file mode 100644 index 0000000000..43647176a6 --- /dev/null +++ b/teams/teams-ps/teams/Test-CsVoiceNormalizationRule.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/test-csvoicenormalizationrule +applicable: Microsoft Teams +title: Test-CsVoiceNormalizationRule +schema: 2.0.0 +manager: bulenteg +author: serdarsoysal +ms.author: serdars +--- + +# Test-CsVoiceNormalizationRule + +## SYNOPSIS +Tests a telephone number against a voice normalization rule and returns the number after the normalization rule has been applied. +Voice normalization rules are typically used to convert a telephone dialing requirement (for example, you must dial 9 to access an outside line) to the E.164 phone +number format. +This cmdlet was introduced in Lync Server 2010. + +## SYNTAX + +``` +Test-CsVoiceNormalizationRule -DialedNumber -NormalizationRule + [] +``` + +## DESCRIPTION +This cmdlet allows you to see the results of applying a voice normalization rule to a given telephone number. +Voice normalization rules are a required part of phone authorization and call routing. +They define the requirements for converting--or translating-- numbers from a format typically entered by users to a standard (E.164) format. +Use this cmdlet to troubleshoot dialing issues or to verify that rules will work as expected against given numbers. + +## EXAMPLES + +### -------------------------- Example 1 -------------------------- +``` +Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" | Test-CsVoiceNormalizationRule -DialedNumber 14255559999 +``` + +For Lync or Skype for Business Server, this example runs a voice normalization test against the voice normalization rule with the Identity "global/11 digit number rule". +First the `Get-CsVoiceNormalizationRule` cmdlet is run to retrieve the rule with the Identity "global/11 digit number rule". +That rule object is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where the rule is tested against the telephone number 14255559999. +The output will be the DialedNumber after the voice normalization rule "global/11 digit number rule" has been applied. +If this rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) no value will be returned. + +### -------------------------- Example 2 -------------------------- +``` +$a = Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" +Test-CsVoiceNormalizationRule -DialedNumber 5551212 -NormalizationRule $a +``` + +For Lync or Skype for Business Server, example 2 is identical to Example 1 except that instead of piping the results of the Get operation directly to the Test cmdlet, the +object is first stored in the variable $a and then is passed as the value to the parameter NormalizationRule to be used as the voice normalization rule against which the +test will run. + +### -------------------------- Example 3 -------------------------- +``` +Get-CsVoiceNormalizationRule | Test-CsVoiceNormalizationRule -DialedNumber 2065559999 +``` + +For Lync or Skype for Business Server, this example runs a voice normalization test against all voice normalization rules defined within the Skype for Business +Server deployment. First the `Get-CsVoiceNormalizationRule` cmdlet is run (with no parameters) to retrieve all the voice normalization rules. +The collection of rules that is returned is then piped to the `Test-CsVoiceNormalizationRule` cmdlet, where each rule in the collection is tested against the telephone +number 2065559999. The output will be a list of translated numbers, one for each rule tested. +If a rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) there +will be a blank line in the list for that rule. + +### -------------------------- Example 4 -------------------------- +```powershell +$nr=(Get-CsTenantDialPlan -Identity dp1).NormalizationRules +$nr[0] +``` +```output +Description : +Pattern : ^(\d{4})$ +Translation : +1206555$1 +Name : nr1 +IsInternalExtension : False +``` +```powershell +Test-CsVoiceNormalizationRule -DialedNumber 1234 -NormalizationRule $nr[0] +``` +```output +TranslatedNumber +---------------- ++12065551234 +``` + +For Microsoft Teams, this example gets all the normalization rules in the tenant dial plan DP1, shows the first of these rules, and then test that rule on the +dialed number 1234. The output shows that the rule normalize the dialed number to +12065551234. + +## PARAMETERS + +### -DialedNumber +The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter. + +Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber + +```yaml +Type: PhoneNumber +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NormalizationRule +An object containing a reference to the normalization rule against which you want to test the number specified in the DialedNumber parameter. + +For Lync and Skype for Business Server, you can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. +For Microsoft Teams, you can retrieve voice normalization rules by calling the `Get-CsTenantDialPlan` cmdlet. + +```yaml +Type: NormalizationRule +Parameter Sets: (All) +Aliases: +Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +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/?LinkID=113216). + +## INPUTS + +### Input types +Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +Accepts pipelined input of voice normalization rule objects. + +## OUTPUTS + +### Output types +Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestResult. + +## NOTES + +## RELATED LINKS + +[New-CsVoiceNormalizationRule](https://learn.microsoft.com/powershell/module/teams/new-csvoicenormalizationrule) + +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) diff --git a/skype/skype-ps/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md b/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md similarity index 80% rename from skype/skype-ps/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md index 35e9228651..a2f7712c39 100644 --- a/skype/skype-ps/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Unregister-CsOnlineDialInConferencingServiceNumber.md @@ -1,13 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/unregister-csonlinedialinconferencingservicenumber -applicable: Skype for Business Online +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +online version: https://learn.microsoft.com/powershell/module/teams/unregister-csonlinedialinconferencingservicenumber +applicable: Microsoft Teams title: Unregister-CsOnlineDialInConferencingServiceNumber schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Unregister-CsOnlineDialInConferencingServiceNumber @@ -30,12 +30,11 @@ Unassigns the previously assigned service number as default Conference Bridge nu ### -------------------------- Example 1 -------------------------- ``` -Unregister-CsOnlineDialInConferencingServiceNumber -BridgeName "Conference Bridge" -RemoveDefaultServiceNumber 1234 +Unregister-CsOnlineDialInConferencingServiceNumber -BridgeName "Conference Bridge" -RemoveDefaultServiceNumber 1234 ``` Unassigns the 1234 Service Number to the given Conference Bridge. - ## PARAMETERS ### -Identity @@ -44,8 +43,8 @@ PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -60,8 +59,8 @@ PARAMVALUE: ConferencingServiceNumber ```yaml Type: ConferencingServiceNumber Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 1 @@ -76,8 +75,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -92,8 +91,8 @@ PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -109,7 +108,7 @@ PARAMVALUE: Fqdn Type: Fqdn Parameter Sets: (All) Aliases: DC -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -124,8 +123,8 @@ PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -140,8 +139,8 @@ PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -156,8 +155,8 @@ PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -172,8 +171,8 @@ PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -183,7 +182,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -192,4 +191,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/skype/skype-ps/skype/Update-CsAutoAttendant.md b/teams/teams-ps/teams/Update-CsAutoAttendant.md similarity index 70% rename from skype/skype-ps/skype/Update-CsAutoAttendant.md rename to teams/teams-ps/teams/Update-CsAutoAttendant.md index 81661a85a4..e904781ef4 100644 --- a/skype/skype-ps/skype/Update-CsAutoAttendant.md +++ b/teams/teams-ps/teams/Update-CsAutoAttendant.md @@ -1,13 +1,13 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/update-csautoattendant -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/update-csautoattendant +applicable: Microsoft Teams title: Update-CsAutoAttendant schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Update-CsAutoAttendant @@ -24,8 +24,7 @@ Update-CsAutoAttendant -Identity [-Tenant ] [] ## DESCRIPTION This cmdlet provides a way to update the resources associated with an auto attendant configured for use in your organization. Currently, it repairs the Dial-by-Name recognition status of an auto attendant. -Note: This cmdlet only triggers the refresh of auto attendant resources. It does not wait until all the resources have been refreshed. The last completed status of auto attendant can be retrieved using [`Get-CsAutoAttendantStatus`](Get-CsAutoAttendantStatus.md) cmdlet. - +Note: This cmdlet only triggers the refresh of auto attendant resources. It does not wait until all the resources have been refreshed. The last completed status of auto attendant can be retrieved using [`Get-CsAutoAttendantStatus`](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) cmdlet. ## EXAMPLES @@ -45,7 +44,7 @@ The identity for the AA whose resources are to be updated. Type: System.String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: True Position: 0 @@ -60,7 +59,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -70,27 +69,25 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String The Update-CsAutoAttendant cmdlet accepts a string as the Identity parameter. - ## OUTPUTS ### None - ## NOTES ## RELATED LINKS -[Get-CsAutoAttendant](Get-CsAutoAttendant.md) +[Get-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/get-csautoattendant) -[Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) -[Set-CsAutoAttendant](Set-CsAutoAttendant.md) +[Set-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/set-csautoattendant) -[Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) diff --git a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md b/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md index 51c82e3659..b993377f9a 100644 --- a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md +++ b/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md @@ -5,7 +5,7 @@ title: Update-CsCustomPolicyPackage author: sunguchuan ms.author: gucsun manager: dasosby -online version: https://docs.microsoft.com/powershell/module/teams/update-cscustompolicypackage +online version: https://learn.microsoft.com/powershell/module/teams/update-cscustompolicypackage schema: 2.0.0 --- @@ -25,7 +25,7 @@ Update-CsCustomPolicyPackage -Identity -PolicyList [-Descrip ## DESCRIPTION -This cmdlet updates a custom policy package with new package settings. For more information on policy packages and the policy types available, please review https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages. +This cmdlet updates a custom policy package with new package settings. For more information on policy packages and the policy types available, please review https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages. ## EXAMPLES @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -PolicyList -A list of one or more policies to be included in the updated package. To specifiy the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://docs.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, please use the SkypeForBusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://docs.microsoft.com/powershell/module/skype/get-csteamsmessagingpolicy?view=skype-ps). +A list of one or more policies to be included in the updated package. To specify the policy list, follow this format: "\, \". Delimiters of ' ', '.', ':', '\t' are also acceptable. Supported policy types are listed [here](https://learn.microsoft.com/MicrosoftTeams/manage-policy-packages#what-is-a-policy-package). To get the list of available policy names on your tenant, use the skypeforbusiness module and refer to cmdlets such as [Get-CsTeamsMeetingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingpolicy) and [Get-CsTeamsMessagingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingpolicy). ```yaml Type: String[] @@ -104,8 +104,8 @@ The resulting custom package's contents will be replaced by the new one instead ## RELATED LINKS -[Get-CsPolicyPackage](Get-CsPolicyPackage.md) +[Get-CsPolicyPackage](https://learn.microsoft.com/powershell/module/teams/get-cspolicypackage) -[New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) +[New-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/new-cscustompolicypackage) -[Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) +[Remove-CsCustomPolicyPackage](https://learn.microsoft.com/powershell/module/teams/remove-cscustompolicypackage) diff --git a/teams/teams-ps/teams/Update-CsPhoneNumberTag.md b/teams/teams-ps/teams/Update-CsPhoneNumberTag.md new file mode 100644 index 0000000000..31d633d8dd --- /dev/null +++ b/teams/teams-ps/teams/Update-CsPhoneNumberTag.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: Microsoft.Teams.ConfigAPI.Cmdlets +online version: https://learn.microsoft.com/powershell/module/teams/update-csphonenumbertag +applicable: Microsoft Teams +title: Update-CsPhoneNumberTag +author: pavellatif +ms.author: pavellatif +ms.reviewer: pavellatif +manager: roykuntz +schema: 2.0.0 +--- + +# Update-CsPhoneNumberTag + +## SYNOPSIS +This cmdlet allows admin to update existing telephone number tags. + +## SYNTAX + +``` +Update-CsPhoneNumberTag -NewTag -Tag [] +``` + +## DESCRIPTION +This cmdlet can be used to update existing tags for telephone numbers. Tags can be up to 50 characters long, including spaces, and can contain multiple words. They are not case-sensitive. An admin can get a list of all existing tags using [Get-CsPhoneNumberTag](https://learn.microsoft.com/powershell/module/teams/get-csphonenumbertag). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Update-CsPhoneNumberTag -Tag "Redmond" -NewTag "Redmond HQ" +``` + +This example shows how to update an existing tag "Redmond" to "Redmond HQ" + +## PARAMETERS + +### -NewTag +This is the new tag. A tag can be maximum 50 characters long. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +This is the old tag which the admin wants to update. + +```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.Boolean + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Update-CsTeamTemplate.md b/teams/teams-ps/teams/Update-CsTeamTemplate.md index 7a96c7f326..67710e31ba 100644 --- a/teams/teams-ps/teams/Update-CsTeamTemplate.md +++ b/teams/teams-ps/teams/Update-CsTeamTemplate.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: Microsoft.Teams.ConfigAPI.Cmdlets -online version: https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate +online version: https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate title: Update-CsTeamTemplate author: serdarsoysal ms.author: serdars -ms.reviewer: +ms.reviewer: manager: schema: 2.0.0 --- @@ -71,7 +71,7 @@ Update-CsTeamTemplate -InputObject -DisplayName ### EXAMPLE 1 ```powershell -PS C:> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json +PS C:\> (Get-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR') > input.json # open json in your favorite editor, make changes Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body (Get-Content '.\input.json' | Out-String) @@ -83,7 +83,7 @@ Step 2: Updates the template with JSON file you have edited. ### EXAMPLE 2 ```powershell -PS C:> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` +PS C:\> $template = New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.TeamTemplate -Property @{` DisplayName='New Template';` ShortDescription='Short Definition';` Description='New Description';` @@ -100,7 +100,7 @@ Channel=@{` }` } -PS C:> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' -Body $template ``` Update to a new object @@ -108,7 +108,7 @@ Update to a new object ### EXAMPLE 3 ```powershell -PS C:> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` +PS C:\> Update-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/bfd1ccc8-40f4-4996-833f-461947d23348/Tenant/fr-FR' ` -Locale en-US -DisplayName 'New Template' ` -ShortDescription 'New Description' ` -App @{id='feda49f8-b9f2-4985-90f0-dd88a8f80ee1'}, @{id='1d71218a-92ad-4254-be15-c5ab7a3e4423'} ` @@ -123,6 +123,8 @@ isFavoriteByDefault= $true ` isFavoriteByDefault= $false ` } ``` +> [!Note] +> It can take up to 24 hours for Teams users to see a custom template change in the gallery. ## PARAMETERS @@ -196,7 +198,7 @@ Accept wildcard characters: False ### -Classification -Gets or sets the team's classification.Tenant admins configure AAD with the set of possible values. +Gets or sets the team's classification.Tenant admins configure Microsoft Entra ID with the set of possible values. ```yaml Type: System.String @@ -328,7 +330,7 @@ Accept wildcard characters: False ### -IsMembershipLimitedToOwner -Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. +Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. ```yaml Type: System.Management.Automation.SwitchParameter @@ -394,7 +396,7 @@ Accept wildcard characters: False ### -OwnerUserObjectId -Gets or sets the AAD user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. +Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team.Only to be used when an application or administrative user is making the request on behalf of the specified user. ```yaml Type: System.String @@ -672,7 +674,7 @@ BODY \: The client input for a request to create a template. - `[Description ]`: Gets or sets channel description as displayed to users. - `[DisplayName ]`: Gets or sets channel name as displayed to users. - `[Id ]`: Gets or sets identifier for the channel template. - - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. + - `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration ]`: Represents the configuration of a tab. - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. @@ -686,7 +688,7 @@ BODY \: The client input for a request to create a template. - `[SortOrderIndex ]`: Gets or sets index of the order used for sorting tabs. - `[TeamsAppId ]`: Gets or sets the app's id in the global apps catalog. - `[WebUrl ]`: Gets or sets the deep link url of the tab instance. -- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure AAD with the set of possible values. +- `[Classification ]`: Gets or sets the team's classification. Tenant admins configure Microsoft Entra ID with the set of possible values. - `[Description ]`: Gets or sets the team's Description. - `[DiscoverySetting ]`: Governs discoverability of a team. - `ShowInTeamsSearchAndSuggestion `: Gets or sets value indicating if team is visible within search and suggestions in Teams clients. @@ -699,7 +701,7 @@ BODY \: The client input for a request to create a template. - `AllowCreateUpdateChannel `: Gets or sets a value indicating whether guests can create or edit channels in the team. - `AllowDeleteChannel `: Gets or sets a value indicating whether guests can delete team channels. - `[Icon ]`: Gets or sets template icon. -- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the AAD group until an owner "activates" the team. +- `[IsMembershipLimitedToOwner ]`: Gets or sets whether to limit the membership of the team to owners in the Microsoft Entra group until an owner "activates" the team. - `[MemberSetting ]`: Member role settings for the team. - `AllowAddRemoveApp `: Gets or sets a value indicating whether members can add or remove apps in the team. - `AllowCreatePrivateChannel `: Gets or Sets a value indicating whether members can create Private channels. @@ -714,7 +716,7 @@ BODY \: The client input for a request to create a template. - `AllowTeamMention `: Gets or sets a value indicating whether team members can at-mention the entire team in team conversations. - `AllowUserDeleteMessage `: Gets or sets a value indicating whether team members can delete their own messages in team conversations. - `AllowUserEditMessage `: Gets or sets a value indicating whether team members can edit their own messages in team conversations. -- `[OwnerUserObjectId ]`: Gets or sets the AAD user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. +- `[OwnerUserObjectId ]`: Gets or sets the Microsoft Entra user object id of the user who should be set as the owner of the new team. Only to be used when an application or administrative user is making the request on behalf of the specified user. - `[PublishedBy ]`: Gets or sets published name. - `[Specialization ]`: The specialization or use case describing the team. Used for telemetry/BI, part of the team context exposed to app developers, and for legacy implementations of differentiated features for education. - `[TemplateId ]`: Gets or sets the id of the base template for the team. Either a Microsoft base template or a custom template. @@ -726,7 +728,7 @@ CHANNEL : Gets or sets the set of channel templates included - `[Description ]`: Gets or sets channel description as displayed to users. - `[DisplayName ]`: Gets or sets channel name as displayed to users. - `[Id ]`: Gets or sets identifier for the channel template. -- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. +- `[IsFavoriteByDefault ]`: Gets or sets a value indicating whether new members of the team should automatically favorite the channel, pinning it for visibility in the UI and using resources to make switching to the channel faster. - `[Tab ]`: Gets or sets collection of tabs that should be added to the channel. - `[Configuration ]`: Represents the configuration of a tab. - `[ContentUrl ]`: Gets or sets the Url used for rendering tab contents in Teams. @@ -800,8 +802,8 @@ MESSAGINGSETTING \: Governs use of messaging features w ## RELATED LINKS -- [Get-CsTeamTemplateList](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/get-csteamtemplate) -- [New-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/new-csteamtemplate) -- [Update-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/update-csteamtemplate) -- [Remove-CsTeamTemplate](https://docs.microsoft.com/powershell/module/teams/remove-csteamtemplate) +- [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) +- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md new file mode 100644 index 0000000000..776c82c956 --- /dev/null +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -0,0 +1,433 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Update-CsTeamsShiftsConnection +author: serdarsoysal +ms.author: serdars +manager: +online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection +schema: 2.0.0 +--- + +# Update-CsTeamsShiftsConnection + +## SYNOPSIS +This cmdlet updates an existing workforce management (WFM) connection. + +## SYNTAX + +### Update (Default) +```powershell +Update-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateExpanded +```powershell +Update-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] + [-ConnectorSpecificSettings ] [-Etag ] [-Name ] + [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] +[-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +```powershell +Update-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] + [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] + [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] + [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity +```powershell +Update-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] + [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet updates a Shifts WFM connection. Similar to the Set-CsTeamsShiftsConnection cmdlet, it allows the admin to make changes to the settings in the connection. The complete list of fields is not required allowing the user to update single fields of the connection. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -name "Cmdlet test connection - updated" ` + +PS C:\> $result | Format-List +``` + +```output + +ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 +ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta2 +ConnectorSpecificSettingApiUrl : +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : +ConnectorSpecificSettingCookieAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingEssApiUrl : https://www.contoso.com/retail/data/wfmess/api/v1-beta2 +ConnectorSpecificSettingFederatedAuthUrl : https://www.contoso.com/retail/data/login +ConnectorSpecificSettingRetailWebApiUrl : https://www.contoso.com/retail/data/retailwebapi/api/v1 +ConnectorSpecificSettingSiteManagerUrl : https://www.contoso.com/retail/data/wfmsm/api/v1-beta2 +ConnectorSpecificSettingSsoUrl : +CreatedDateTime : 24/03/2023 04:58:23 +Etag : "5b00dd1b-0000-0400-0000-641d2df00000" +Id : 4dae9db0-0841-412c-8d6b-f5684bfebdd7 +LastModifiedDateTime : 24/03/2023 04:58:23 +Name : Cmdlet test connection - updated +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 + +``` + +Updates the connection with the specified -ConnectionId with the given name. Returns the object of the updated connection. + +### Example 2 + +```powershell +PS C:\> $connection = Get-CsTeamsShiftsConnection -ConnectionId 79964000-286a-4216-ac60-c795a426d61a +PS C:\> $result = Update-CsTeamsShiftsConnection ` + -connectionId $connection.Id ` + -IfMatch $connection.Etag ` + -connectorId "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0" ` + -connectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` + -Property @{ + apiUrl = "https://www.contoso.com/api" + ssoUrl = "https://www.contoso.com/sso" + appKey = "PlaceholderForAppKey" + clientId = "Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W" + clientSecret = "PlaceholderForClientSecret" + }) ` + -state "Active" +PS C:\> $result | Format-List +``` + +```output +ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED4C0A0 +ConnectorSpecificSettingAdminApiUrl : +ConnectorSpecificSettingApiUrl : https://www.contoso.com/api +ConnectorSpecificSettingAppKey : +ConnectorSpecificSettingClientId : Es5Q2fB4PXweCyto6Ms6J2kRB7uwAc3W +ConnectorSpecificSettingCookieAuthUrl : +ConnectorSpecificSettingEssApiUrl : +ConnectorSpecificSettingFederatedAuthUrl : +ConnectorSpecificSettingRetailWebApiUrl : +ConnectorSpecificSettingSiteManagerUrl : +ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso +CreatedDateTime : 06/04/2023 11:05:39 +Etag : "3100fd6e-0000-0400-0000-642ea7840000" +Id : 79964000-286a-4216-ac60-c795a426d61a +LastModifiedDateTime : 06/04/2023 11:05:39 +Name : Cmdlet test connection +State : Active +TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 +``` + +Updates the connection with the specified -ConnectionId with the given settings. Returns the object of the updated connection. + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateWfmConnectionFieldsRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the ETag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection. + +```yaml +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +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 +``` + +### -Authorization +Used to provide the necessary credentials for authenticating and authorizing the connection to the workforce management (WFM) system. This parameter ensures that the connection has the appropriate permissions to access and manage the data within the WFM system. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorId +Used to specify the unique identifier of the connector being used for the connection. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorSpecificSettings +Used to specify settings that are unique to the connector being used. This parameter allows administrators to configure various properties specific to the workforce management (WFM) system they are integrating with Teams Shifts. + +```yaml +Type: IUpdateWfmConnectionFieldsRequestConnectorSpecificSettings +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateWfmConnectionFieldsRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IWfmConnectionResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) + +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) + +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md new file mode 100644 index 0000000000..466a0bf1c7 --- /dev/null +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -0,0 +1,529 @@ +--- +external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml +Module Name: MicrosoftTeams +title: Update-CsTeamsShiftsConnectionInstance +author: nunocorreia-ms +ms.author: nunocorreia +manager: +online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance +schema: 2.0.0 +--- + +# Update-CsTeamsShiftsConnectionInstance + +## SYNOPSIS +This cmdlet updates Shifts connection instance fields. + +## SYNTAX + +### Update (Default) +```powershell +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -Body [-Break] +[-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +[-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateExpanded +```powershell +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] +[-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] + [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] + [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +```powershell +Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch + [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] + [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] +[-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] +[-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity +```powershell +Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This cmdlet updates a Shifts connection instance. Similar to the Set-CsTeamsShiftsConnectionInstance cmdlet, it allows the admin to make changes to the settings in the instance such as name, enabled scenarios, and sync frequency. The complete list of fields is not required allowing the user to update single fields of the instance. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 +PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` + -connectorInstanceId "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1" + -IfMatch $connectionInstance.Etag ` + -connectionId "79964000-286a-4216-ac60-c795a426d61a" ` + -name "Cmdlet test instance - updated" ` + -syncFrequencyInMin "30" ` + +PS C:\> $result.ToJsonString() +``` + +```output + +{ + "syncScenarios": { + "offerShiftRequest": "FromWfmToShifts", + "openShift": "FromWfmToShifts", + "openShiftRequest": "FromWfmToShifts", + "shift": "FromWfmToShifts", + "swapRequest": "FromWfmToShifts", + "timeCard": "FromWfmToShifts", + "timeOff": "FromWfmToShifts", + "timeOffRequest": "FromWfmToShifts", + "userShiftPreferences": "Disabled" + }, + "id": "WCI-eba2865f-6cac-46f9-8733-e0631a4536e1", + "tenantId": "dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a", + "connectionId": "a2d1b091-5140-4dd2-987a-98a8b5338744", + "connectorAdminEmails": [ ], + "connectorId": "95BF2848-2DDA-4425-B0EE-D62AEED4C0A0", + "designatedActorId": "ec1a4edb-1a5f-4b2d-b2a4-37aab6ebd231", + "name": "Cmdlet test instance - updated", + "syncFrequencyInMin": 30, + "workforceIntegrationId": "WFI_6b225907-b476-4d40-9773-08b86db7b11b", + "etag": "\"4f005d22-0000-0400-0000-642ff64a0000\"", + "createdDateTime": "2023-04-07T10:54:01.8170000Z", + "lastModifiedDateTime": "2023-04-07T10:54:01.8170000Z", + "state" : "Active" +} + +``` + +Updates the instance with the specified -ConnectorInstanceId with the given name and sync frequency. Returns the object of the updated connector instance. + +## PARAMETERS + +### -Body +The request body. + +```yaml +Type: IUpdateConnectorInstanceFieldsRequest +Parameter Sets: Update, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Break +Wait for the .NET debugger to attach. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorAdminEmail +Gets or sets the list of connector admin email addresses. + +```yaml +Type: String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectorInstanceId +The connector instance ID. + +```yaml +Type: String +Parameter Sets: Update, UpdateExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedActorId +The designated actor ID that App acts as for Shifts Graph API calls. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioOpenShiftRequest +The sync state for the open shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncScenarioUserShiftPreference +The sync state for the user shift preferences scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline. + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IfMatch +The value of the ETag field as returned by the cmdlets. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: IConfigApiBasedCmdletsIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The connector instance name. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -State +The state of the connection instance. Valid values are "Active" and "Disabled". A third value, "ErrorDisabled", signifies an error in the connection instance. + +```yaml +Type: String +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SyncFrequencyInMin +The sync frequency in minutes. + +```yaml +Type: Int32 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: +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 +``` + +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IUpdateConnectorInstanceFieldsRequest + +## OUTPUTS + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConnectorInstanceResponse + +### Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorDetailsResponse + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) + +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) + +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) + +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) + +[Test-CsTeamsShiftsConnectionValidate](https://learn.microsoft.com/powershell/module/teams/test-csteamsshiftsconnectionvalidate) diff --git a/teams/teams-ps/teams/Update-M365TeamsApp.md b/teams/teams-ps/teams/Update-M365TeamsApp.md new file mode 100644 index 0000000000..7fccff1744 --- /dev/null +++ b/teams/teams-ps/teams/Update-M365TeamsApp.md @@ -0,0 +1,255 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365TeamsApp +applicable: Microsoft Teams +title: Update-M365TeamsApp +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 04/24/2024 +schema: 2.0.0 +--- + +# Update-M365TeamsApp + +## SYNOPSIS + +This cmdlet updates app state and app available values for the Microsoft Teams app. + +## SYNTAX + +```powershell +Update-M365TeamsApp -Id [-IsBlocked ] -AppAssignmentType -OperationType + [-Users ] [-Groups ] -AppInstallType -InstallForOperationType [-InstallForUsers -InstallForGroups -InstallVersion ] [] +``` + +## DESCRIPTION + +This cmdlet allows administrators to modify app state, availability and installation status by adding or removing users and groups or changing assignment type or installation status. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Update-M365TeamsApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -AppAssignmentType Everyone +``` +Updates the availability value for Bookings app (App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b) to Everyone. + +### Example 2 + +```powershell +PS C:\> Update-M365TeamsApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -IsBlocked $true -AppAssignmentType UsersAndGroups -OperationType Add -Users eec823bd-0979-4cf8-9924-85bb6ffcb57d, eec823bd-0979-4cf8-9924-85bb6ffcb57e -Groups 37da2d58-fc14-453e-9a14-5065ebd63a1d, 37da2d58-fc14-453e-9a14-5065ebd63a1e, 37da2d58-fc14-453e-9a14-5065ebd63a1b, 37da2d58-fc14-453e-9a14-5065ebd63a1f, 37da2d58-fc14-453e-9a14-5065ebd63a1a +``` +Unblocks CSP Customer App (App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b) and updates availability setting for the app to include 2 users and 5 groups. + +### Example 3 + +```powershell +PS C:\> Update-M365TeamsApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -IsBlocked $true +``` +Unblocks Bookings app (App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b). + +### Example 4 + +```powershell +PS C:\> Update-M365TeamsApp -Id 2b876f4d-2e6b-4ee7-9b09-8893808c1380 -IsBlocked $false -AppInstallType UsersAndGroups -InstallForOperationType Add -InstallForUsers 77f5d400-a12e-4168-8e63-ccd2243d33a8,f2f4d8bc-1fb3-4292-867e-6d19efb0eb7c,37b6fc6a-32a4-4767-ac2e-c2f2307bad5c -InstallForGroups 926d57ad-431c-4e6a-9e16-347eacc91aa4 -InstallVersion 4.1.2 +``` +Unblocks 1Page App (App ID 2b876f4d-2e6b-4ee7-9b09-8893808c1380) and updates installation setting for the app to include 3 users and 1 group. + +## PARAMETERS + +### -AppAssignmentType + +App availability type. + +```yaml +Type: String +Parameter Sets: (Everyone, UsersandGroups, Noone) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups + +List of all the groups for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id + +Application ID of Microsoft Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsBlocked + +The state of the app in the tenant. + +```yaml +Type: Boolean +Parameter Sets: (true, false) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OperationType + +Operation performed on the app assigment. + +```yaml +Type: String +Parameter Sets: (Add, Remove) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users + +List of all the users for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppInstallType + +App installation type. + +```yaml +Type: String +Parameter Sets: (Everyone, UsersandGroups, Noone) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallForOperationType + +Operation performed on the app installation. + +```yaml +Type: String +Parameter Sets: (Add, Remove) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallForUsers + +List of all the users for whom the app is installed. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallForGroups + +List of all the groups for whom the app is installed. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstallVersion + +App version to be installed. + +```yaml +Type: String +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 + +[Get-AllM365TeamsApps](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) +[Get-M365TeamsApp](https://learn.microsoft.com/powershell/module/teams/get-allm365teamsapps) diff --git a/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md b/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md new file mode 100644 index 0000000000..f2292aee01 --- /dev/null +++ b/teams/teams-ps/teams/Update-M365UnifiedCustomPendingApp.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedCustomPendingApp +applicable: Microsoft Teams +title: Update-M365UnifiedCustomPendingApp +author: michelle-paradis +ms.author: mparadis +manager: swmerchant +ms.date: 01/20/2025 +schema: 2.0.0 +--- + +# Update-M365UnifiedCustomPendingApp + +## SYNOPSIS + +This cmdlet updates the review status for a custom Microsoft Teams app that is pending review from an IT Admin. The requester to publish the custom app will not be notified when this cmdlet is completed. + +## SYNTAX + +```powershell +Update-M365UnifiedCustomPendingApp -Id -ReviewStatus +``` + +## DESCRIPTION + +This cmdlet allows administrators to reject or publish custom Microsoft Teams apps that are pending review from an IT Admin. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Published +``` +Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Published. + +### Example 2 + +```powershell +PS C:\> Update-M365UnifiedCustomPendingApp -Id 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b -ReviewStatus Rejected +``` +Updates the review status for the custom pending app with App ID 4c4ec2e8-4a2c-4bce-8d8f-00fc664a4e5b to Rejected. + +## PARAMETERS + +### Id + +Application ID of the Teams app. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### ReviewStatus + +The review status of the Teams app. + +```yaml +Type: String +Parameter Sets: (Published, Rejected) +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 diff --git a/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md b/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md new file mode 100644 index 0000000000..ed119948d2 --- /dev/null +++ b/teams/teams-ps/teams/Update-M365UnifiedTenantSettings.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365UnifiedTenantSettings +applicable: Microsoft Teams +title: Update-M365UnifiedTenantSettings +author: lkueter +ms.author: sribagchi +manager: rahulrgupta +ms.date: 10/22/2024 +schema: 2.0.0 +--- + +# Update-M365UnifiedTenantSettings + +## SYNOPSIS + +This cmdlet updates tenant settings. + +## SYNTAX + +```powershell +Update-M365UnifiedTenantSettings -SettingName -SettingValue [-Users ] [-Groups ] [-Operation ] [] +``` + +## DESCRIPTION + +This cmdlet allows administrators to modify tenant settings. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> PS C:\> Update-M365UnifiedTenantSettings -SettingName EnableCopilotExtensibility -SettingValue Some -Users d156010d-fb18-497f-804c-155ec2aa06d3,a62fba7e-e362-493c-a094-fdec17e2fee8 -Groups 37da2d58-fc14-453e-9a14-5065ebd63a1d, 37da2d58-fc14-453e-9a14-5065ebd63a1e -Operation add +``` +Updates the tenant setting for EnableCopilotExtensibility to 2 users and 2 groups. + +### Example 2 + +```powershell +PS C:\> Update-M365UnifiedTenantSettings -SettingName GlobalApp -SettingValue None +``` +Updates the tenant setting for GlobalApp to None + +## PARAMETERS + +### -SettingName + +Setting Name to be changed. + +```yaml +Type: String +Parameter Sets: (DefaultApp, GlobalApp, PrivateApp, EnableCopilotExtensibility) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SettingValue +Setting Value to be changed. + +```yaml +Type: String +Parameter Sets: (All, None, Some) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation + +Operation performed (whether we are adding or removing users/groups). + +```yaml +Type: String +Parameter Sets: (add, remove) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Users + +List of all the users for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups + +List of all the groups for whom the app is enabled or disabled. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/teams/teams-ps/teams/Update-TeamsAppInstallation.md b/teams/teams-ps/teams/Update-TeamsAppInstallation.md index c9b1d02743..d7ce547680 100644 --- a/teams/teams-ps/teams/Update-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Update-TeamsAppInstallation.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams -online version: https://docs.microsoft.com/powershell/module/teams/update-teamsappinstallation +online version: https://learn.microsoft.com/powershell/module/teams/update-teamsappinstallation +title: Update-TeamsAppInstallation schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -31,7 +32,7 @@ Update-TeamsAppInstallation [-AppInstallationId ] [-AppId ] -Use Update a Teams App in Microsoft Teams. This won't update teams client; this will update an application installed on the user/team. -Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://docs.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://docs.microsoft.com/microsoftteams/teams-powershell-release-notes). +Note: This cmdlet is part of the Public Preview version of Teams PowerShell Module, for more information see [Install Teams PowerShell public preview](https://learn.microsoft.com/microsoftteams/teams-powershell-install#install-teams-powershell-public-preview) and also see [Microsoft Teams PowerShell Release Notes](https://learn.microsoft.com/microsoftteams/teams-powershell-release-notes). ## EXAMPLES @@ -136,6 +137,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/export-csonlineaudiofile.md b/teams/teams-ps/teams/export-csonlineaudiofile.md similarity index 75% rename from skype/skype-ps/skype/export-csonlineaudiofile.md rename to teams/teams-ps/teams/export-csonlineaudiofile.md index e5e1070fea..f0b747b543 100644 --- a/skype/skype-ps/skype/export-csonlineaudiofile.md +++ b/teams/teams-ps/teams/export-csonlineaudiofile.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://docs.microsoft.com/powershell/module/skype/export-csonlineaudiofile +online version: https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile applicable: Microsoft Teams title: Export-CsOnlineAudioFile schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,14 +18,12 @@ Use the Export-CsOnlineAudioFile cmdlet to download an existing audio file. ## SYNTAX ```powershell -Export-CsOnlineAudioFile [[-Identity] ] [-ApplicationId] ] [] +Export-CsOnlineAudioFile [[-Identity] ] [-ApplicationId ] [] ``` - ## DESCRIPTION The Export-CsOnlineAudioFile cmdlet downloads an existing Auto Attendant (AA), Call Queue (CQ) service or Music on Hold audio file. - ## EXAMPLES ### -------------------------- Example 1 -------------------------- @@ -48,7 +46,7 @@ Supported values: - TenantGlobal ```yaml -Type: System.string +Type: String Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -63,7 +61,6 @@ Accept wildcard characters: False ### -Identity The Id of the specific audio file that you would like to export. - ```yaml Type: System.String Parameter Sets: (All) @@ -75,6 +72,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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 @@ -90,8 +90,8 @@ Therefore, ensure that the file extension used to store the content is WAV. You are responsible for independently clearing and securing all necessary rights and permissions to use any music or audio file with your Microsoft Teams service, which may include intellectual property and other rights in any music, sound effects, audio, brands, names, and other content in the audio file from all relevant rights holders, which may include artists, actors, performers, musicians, songwriters, composers, record labels, music publishers, unions, guilds, rights societies, collective management organizations and any other parties who own, control or license the music copyrights, sound effects, audio and other intellectual property rights. ## RELATED LINKS -[Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) -[Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +[Import-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/import-csonlineaudiofile) -[Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +[Remove-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/remove-csonlineaudiofile) diff --git a/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md b/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md new file mode 100644 index 0000000000..fc5ad06309 --- /dev/null +++ b/teams/teams-ps/teams/get-csteamsmessagingconfiguration.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsMessagingConfiguration +title: Get-CsTeamsMessagingConfiguration +schema: 2.0.0 +--- + +# Get-CsTeamsMessagingConfiguration + +## SYNOPSIS + +TeamsMessagingConfiguration determines the messaging settings for users. This cmdlet returns your organization's current settings. + +## SYNTAX + +### Identity (Default) + +```powershell +Get-CsTeamsMessagingConfiguration [[-Identity] ] [] +``` + +### Filter + +```powershell +Get-CsTeamsMessagingConfiguration [-Filter ] [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for users. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-CsTeamsMessagingConfiguration +``` + +The command shown in Example 1 returns teams messaging configuration information for the current tenant. + +## PARAMETERS + +### -Filter + +Enables you to use wildcard characters in order to return a collection of tenant messaging configuration settings. Because each tenant is limited to a single, global collection of the messaging configuration settings there is no need to use the Filter parameter. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +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 + +[Set-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/set-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md b/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md new file mode 100644 index 0000000000..79f4c96eb3 --- /dev/null +++ b/teams/teams-ps/teams/set-csteamsmessagingconfiguration.md @@ -0,0 +1,289 @@ +--- +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml +Module Name: MicrosoftTeams +online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsMessagingConfiguration +title: Set-CsTeamsMessagingConfiguration +schema: 2.0.0 +--- + +# Set-CsTeamsMessagingConfiguration + +## SYNOPSIS + +The TeamsMessagingConfiguration determines the messaging settings for users in your tenant. + +## SYNTAX + +```powershell +Set-CsTeamsMessagingConfiguration [-Identity] + [-Confirm] + [-CustomEmojis ] + [-EnableInOrganizationChatControl ] + [-EnableVideoMessageCaptions ] + [-FileTypeCheck ] + [-Force] + [-MessagingNotes ] + [-UrlReputationCheck ] + [-ContentBasedPhishingCheck ] + [-ReportIncorrectSecurityDetections] + [-WhatIf] + [] +``` + +## DESCRIPTION + +TeamsMessagingConfiguration determines the messaging settings for the users in your tenant. This cmdlet lets you update the user messaging options you'd like to enable in your organization. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-CsTeamsMessagingConfiguration -CustomEmojis $False +``` + +The command shown in example 1 disables custom emojis within Teams. + +## PARAMETERS + +### -Identity + +Specifies the collection of tenant messaging configuration settings to be returned. Because each tenant is limited to a single, global collection of messaging settings there is no need include this parameter when calling the cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomEmojis + +This setting enables/disables the use of custom emojis and reactions across the whole tenant. Upon enablement, admins and/or users can define a user group that is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableInOrganizationChatControl + +This setting determines if chat regulation for internal communication in tenant is allowed. +Possible Values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableVideoMessageCaptions + + This setting determines if closed captions will be displayed, for Teams Video Clips, during playback. + Possible values: True, False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileTypeCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if FileType check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessagingNotes + +This setting enables/disables MessagingNotes integration across the whole tenant. Possible Values: Disabled, Enabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UrlReputationCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if UrlReputationCheck check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentBasedPhishingCheck + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Content Based Phishing Check in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportIncorrectSecurityDetections + +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +This setting determines if Report Incorrect Security Detections is enabled in teams messaging across the whole tenant + +Possible Values: +- Enabled +- Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +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 + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-CsTeamsMessagingConfiguration](https://learn.microsoft.com/powershell/module/teams/get-csteamsmessagingconfiguration) diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index 7fcdaffbac..058504f325 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -12,139 +12,537 @@ The following cmdlet references are for Microsoft Teams. ## Microsoft Teams Cmdlets ### [Add-TeamChannelUser](Add-TeamChannelUser.md) -{{Manually Enter Add-TeamChannelUser Description Here}} - +### [Add-TeamsAppInstallation](Add-TeamsAppInstallation.md) ### [Add-TeamUser](Add-TeamUser.md) -{{Manually Enter Add-TeamUser Description Here}} - +### [Clear-CsOnlineTelephoneNumberOrder](Clear-CsOnlineTelephoneNumberOrder.md) +### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) +### [Complete-CsOnlineTelephoneNumberOrder](Complete-CsOnlineTelephoneNumberOrder.md) ### [Connect-MicrosoftTeams](Connect-MicrosoftTeams.md) -{{Manually Enter Connect-MicrosoftTeams Description Here}} - +### [Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +### [Disable-CsTeamsShiftsConnectionErrorReport](Disable-CsTeamsShiftsConnectionErrorReport.md) ### [Disconnect-MicrosoftTeams](Disconnect-MicrosoftTeams.md) -{{Manually Enter Disconnect-MicrosoftTeams Description Here}} - +### [Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +### [Export-CsAcquiredPhoneNumber](Export-CsAcquiredPhoneNumber.md) +### [Export-CsAutoAttendantHolidays](Export-CsAutoAttendantHolidays.md) +### [export-csonlineaudiofile](export-csonlineaudiofile.md) +### [Find-CsGroup](Find-CsGroup.md) +### [Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +### [Get-AssociatedTeam](Get-AssociatedTeam.md) +### [Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md) +### [Get-CsApplicationMeetingConfiguration](Get-CsApplicationMeetingConfiguration.md) +### [Get-CsAutoAttendant](Get-CsAutoAttendant.md) +### [Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +### [Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +### [Get-CsAutoAttendantSupportedLanguage](Get-CsAutoAttendantSupportedLanguage.md) +### [Get-CsAutoAttendantSupportedTimeZone](Get-CsAutoAttendantSupportedTimeZone.md) +### [Get-CsAutoAttendantTenantInformation](Get-CsAutoAttendantTenantInformation.md) +### [Get-CsBatchPolicyAssignmentOperation](Get-CsBatchPolicyAssignmentOperation.md) +### [Get-CsBatchTeamsDeploymentStatus](Get-CsBatchTeamsDeploymentStatus.md) +### [Get-CsCallingLineIdentity](Get-CsCallingLineIdentity.md) +### [Get-CsCallQueue](Get-CsCallQueue.md) +### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) +### [Get-CsDialPlan](Get-CsDialPlan.md) +### [Get-CsEffectiveTenantDialPlan](Get-CsEffectiveTenantDialPlan.md) +### [Get-CsExportAcquiredPhoneNumberStatus](Get-CsExportAcquiredPhoneNumberStatus.md) +### [Get-CsExternalAccessPolicy](Get-CsExternalAccessPolicy.md) +### [Get-CsGroupPolicyAssignment](Get-CsGroupPolicyAssignment.md) +### [Get-CsHybridTelephoneNumber](Get-CsHybridTelephoneNumber.md) +### [Get-CsInboundBlockedNumberPattern](Get-CsInboundBlockedNumberPattern.md) +### [Get-CsInboundExemptNumberPattern](Get-CsInboundExemptNumberPattern.md) +### [Get-CsMeetingMigrationStatus](Get-CsMeetingMigrationStatus.md) +### [Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +### [Get-CsOnlineApplicationInstanceAssociation](Get-CsOnlineApplicationInstanceAssociation.md) +### [Get-CsOnlineApplicationInstanceAssociationStatus](Get-CsOnlineApplicationInstanceAssociationStatus.md) +### [Get-CsCsOnlineAudioConferencingRoutingPolicy][Get-CsOnlineAudioConferencingRoutingPolicy.md] +### [Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +### [Get-CsOnlineDialinConferencingPolicy](Get-CsOnlineDialinConferencingPolicy.md) +### [Get-CsOnlineDialInConferencingServiceNumber](Get-CsOnlineDialInConferencingServiceNumber.md) +### [Get-CsOnlineDialinConferencingTenantConfiguration](Get-CsOnlineDialinConferencingTenantConfiguration.md) +### [Get-CsOnlineDialInConferencingTenantSettings](Get-CsOnlineDialInConferencingTenantSettings.md) +### [Get-CsOnlineDialInConferencingUser](Get-CsOnlineDialInConferencingUser.md) +### [Get-CsOnlineDialOutPolicy](Get-CsOnlineDialOutPolicy.md) +### [Get-CsOnlineDirectoryTenant](Get-CsOnlineDirectoryTenant.md) +### [Get-CsOnlineEnhancedEmergencyServiceDisclaimer](Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +### [Get-CsOnlineLisCivicAddress](Get-CsOnlineLisCivicAddress.md) +### [Get-CsOnlineLisLocation](Get-CsOnlineLisLocation.md) +### [Get-CsOnlineLisPort](Get-CsOnlineLisPort.md) +### [Get-CsOnlineLisSubnet](Get-CsOnlineLisSubnet.md) +### [Get-CsOnlineLisSwitch](Get-CsOnlineLisSwitch.md) +### [Get-CsOnlineLisWirelessAccessPoint](Get-CsOnlineLisWirelessAccessPoint.md) +### [Get-CsOnlinePSTNGateway](Get-CsOnlinePSTNGateway.md) +### [Get-CsOnlinePstnUsage](Get-CsOnlinePstnUsage.md) +### [Get-CsOnlineSchedule](Get-CsOnlineSchedule.md) +### [Get-CsOnlineSipDomain](Get-CsOnlineSipDomain.md) +### [Get-CsOnlineTelephoneNumber](Get-CsOnlineTelephoneNumber.md) +### [Get-CsOnlineTelephoneNumberCountry](Get-CsOnlineTelephoneNumberCountry.md) +### [Get-CsOnlineTelephoneNumberOrder](Get-CsOnlineTelephoneNumberOrder.md) +### [Get-CsOnlineTelephoneNumberType](Get-CsOnlineTelephoneNumberType.md) +### [Get-CsOnlineUser](Get-CsOnlineUser.md) +### [Get-CsOnlineVoicemailPolicy](Get-CsOnlineVoicemailPolicy.md) +### [Get-CsOnlineVoicemailUserSettings](Get-CsOnlineVoicemailUserSettings.md) +### [Get-CsOnlineVoiceRoute](Get-CsOnlineVoiceRoute.md) +### [Get-CsOnlineVoiceRoutingPolicy](Get-CsOnlineVoiceRoutingPolicy.md) +### [Get-CsOnlineVoiceUser](Get-CsOnlineVoiceUser.md) +### [Get-CsPhoneNumberAssignment](Get-CsPhoneNumberAssignment.md) +### [Get-CsPolicyPackage](Get-CsPolicyPackage.md) +### [Get-CsTeamsAcsFederationConfiguration](Get-CsTeamsAcsFederationConfiguration.md) +### [Get-CsTeamsAppPermissionPolicy](Get-CsTeamsAppPermissionPolicy.md) +### [Get-CsTeamsAppSetupPolicy](Get-CsTeamsAppSetupPolicy.md) +### [Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +### [Get-CsTeamsCallHoldPolicy](Get-CsTeamsCallHoldPolicy.md) +### [Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +### [Get-CsTeamsCallParkPolicy](Get-CsTeamsCallParkPolicy.md) +### [Get-CsTeamsChannelsPolicy](Get-CsTeamsChannelsPolicy.md) +### [Get-CsTeamsClientConfiguration](Get-CsTeamsClientConfiguration.md) +### [Get-CsTeamsComplianceRecordingApplication](Get-CsTeamsComplianceRecordingApplication.md) +### [Get-CsTeamsComplianceRecordingPolicy](Get-CsTeamsComplianceRecordingPolicy.md) +### [Get-CsTeamsCortanaPolicy](Get-CsTeamsCortanaPolicy.md) +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +### [Get-CsTeamsCustomBannerText](Get-CsTeamsCustomBannerText.md) +### [Get-CsTeamsEducationAssignmentsAppPolicy](Get-CsTeamsEducationAssignmentsAppPolicy.md) +### [Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) +### [Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +### [Get-CsTeamsEmergencyCallRoutingPolicy](Get-CsTeamsEmergencyCallRoutingPolicy.md) +### [Get-CsTeamsEnhancedEncryptionPolicy](Get-CsTeamsEnhancedEncryptionPolicy.md) +### [Get-CsTeamsEventsPolicy](Get-CsTeamsEventsPolicy.md) +### [Get-CsTeamsFeedbackPolicy](Get-CsTeamsFeedbackPolicy.md) +### [Get-CsTeamsFilesPolicy](Get-CsTeamsFilesPolicy.md) +### [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md) +### [Get-CsTeamsGuestCallingConfiguration](Get-CsTeamsGuestCallingConfiguration.md) +### [Get-CsTeamsGuestMeetingConfiguration](Get-CsTeamsGuestMeetingConfiguration.md) +### [Get-CsTeamsGuestMessagingConfiguration](Get-CsTeamsGuestMessagingConfiguration.md) +### [Get-CsTeamsIPPhonePolicy](Get-CsTeamsIPPhonePolicy.md) +### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) +### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +### [Get-CsTeamsMeetingBroadcastConfiguration](Get-CsTeamsMeetingBroadcastConfiguration.md) +### [Get-CsTeamsMeetingBroadcastPolicy](Get-CsTeamsMeetingBroadcastPolicy.md) +### [Get-CsTeamsMeetingConfiguration](Get-CsTeamsMeetingConfiguration.md) +### [Get-CsTeamsMeetingPolicy](Get-CsTeamsMeetingPolicy.md) +### [Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.md) +### [Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.md) +### [Get-CsTeamsMessagingConfiguration](Get-CsTeamsMessagingConfiguration.md) +### [Get-CsTeamsMessagingPolicy](Get-CsTeamsMessagingPolicy.md) +### [Get-CsTeamsMobilityPolicy](Get-CsTeamsMobilityPolicy.md) +### [Get-CsTeamsNetworkRoamingPolicy](Get-CsTeamsNetworkRoamingPolicy.md) +### [Get-CsTeamsRecordingRollOutPolicy](Get-CsTeamsRecordingRollOutPolicy.md) +### [Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +### [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +### [Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +### [Get-CsTeamsShiftsConnectionErrorReport](Get-CsTeamsShiftsConnectionErrorReport.md) +### [Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +### [Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.md) +### [Get-CsTeamsShiftsConnectionSyncResult](Get-CsTeamsShiftsConnectionSyncResult.md) +### [Get-CsTeamsShiftsConnectionTeamMap](Get-CsTeamsShiftsConnectionTeamMap.md) +### [Get-CsTeamsShiftsConnectionWfmTeam](Get-CsTeamsShiftsConnectionWfmTeam.md) +### [Get-CsTeamsShiftsConnectionWfmUser](Get-CsTeamsShiftsConnectionWfmUser.md) +### [Get-CsTeamsShiftsPolicy](Get-CsTeamsShiftsPolicy.md) +### [Get-CsTeamsSipDevicesConfiguration](Get-CsTeamsSipDevicesConfiguration.md) +### [Get-CsTeamsSurvivableBranchAppliance](Get-CsTeamsSurvivableBranchAppliance.md) +### [Get-CsTeamsSurvivableBranchAppliancePolicy](Get-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Get-CsTeamsTargetingPolicy](Get-CsTeamsTargetingPolicy.md) +### [Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +### [Get-CsTeamsTranslationRule](Get-CsTeamsTranslationRule.md) +### [Get-CsTeamsUnassignedNumberTreatment](Get-CsTeamsUnassignedNumberTreatment.md) +### [Get-CsTeamsUpdateManagementPolicy](Get-CsTeamsUpdateManagementPolicy.md) +### [Get-CsTeamsUpgradeConfiguration](Get-CsTeamsUpgradeConfiguration.md) +### [Get-CsTeamsUpgradePolicy](Get-CsTeamsUpgradePolicy.md) +### [Get-CsTeamsVdiPolicy](Get-CsTeamsVdiPolicy.md) +### [Get-CsTeamsVideoInteropServicePolicy](Get-CsTeamsVideoInteropServicePolicy.md) +### [Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +### [Get-CsTeamsVoiceApplicationsPolicy](Get-CsTeamsVoiceApplicationsPolicy.md) +### [Get-CsTeamsWorkLoadPolicy](Get-CsTeamsWorkLoadPolicy.md) +### [Get-CsTeamsWorkLocationDetectionPolicy](Get-CsTeamsWorkLocationDetectionPolicy.md) +### [Get-CsTeamTemplate](Get-CsTeamTemplate.md) +### [Get-CsTeamTemplateList](Get-CsTeamTemplateList.md) +### [Get-CsTenant](Get-CsTenant.md) +### [Get-CsTenantBlockedCallingNumbers](Get-CsTenantBlockedCallingNumbers.md) +### [Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +### [Get-CsTenantFederationConfiguration](Get-CsTenantFederationConfiguration.md) +### [Get-CsTenantLicensingConfiguration](Get-CsTenantLicensingConfiguration.md) +### [Get-CsTenantMigrationConfiguration](Get-CsTenantMigrationConfiguration.md) +### [Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +### [Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +### [Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +### [Get-CsTenantTrustedIPAddress](Get-CsTenantTrustedIPAddress.md) +### [Get-CsUserCallingSettings](Get-CsUserCallingSettings.md) +### [Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) +### [Get-CsUserPolicyPackage](Get-CsUserPolicyPackage.md) +### [Get-CsUserPolicyPackageRecommendation](Get-CsUserPolicyPackageRecommendation.md) +### [Get-CsVideoInteropServiceProvider](Get-CsVideoInteropServiceProvider.md) +### [Get-LicenseReportForChangeNotificationSubscription](Get-LicenseReportForChangeNotificationSubscription.md) +### [Get-M365UnifiedCustomPendingApps](Get-M365UnifiedCustomPendingApps.md) +### [Get-SharedWithTeam](Get-SharedWithTeam.md) +### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) ### [Get-Team](Get-Team.md) -{{Manually Enter Get-Team Description Here}} - +### [Get-TeamAllChannel](Get-TeamAllChannel.md) ### [Get-TeamChannel](Get-TeamChannel.md) -{{Manually Enter Get-TeamChannel Description Here}} - ### [Get-TeamChannelUser](Get-TeamChannelUser.md) -{{Manually Enter Get-TeamChannelUser Description Here}} - ### [Get-TeamFunSettings](Get-TeamFunSettings.md) -{{Manually Enter Get-TeamFunSettings Description Here}} - ### [Get-TeamGuestSettings](Get-TeamGuestSettings.md) -{{Manually Enter Get-TeamGuestSettings Description Here}} - -### [Get-TeamHelp](Get-TeamHelp.md) -{{Manually Enter Get-TeamHelp Description Here}} - +### [Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) ### [Get-TeamMemberSettings](Get-TeamMemberSettings.md) -{{Manually Enter Get-TeamMemberSettings Description Here}} - ### [Get-TeamMessagingSettings](Get-TeamMessagingSettings.md) -{{Manually Enter Get-TeamMessagingSettings Description Here}} - ### [Get-TeamsApp](Get-TeamsApp.md) -{{Manually Enter Get-TeamsApp Description Here}} - -### [Get-TeamUser](Get-TeamUser.md) -{{Manually Enter Get-TeamUser Description Here}} - -### [Get-TeamsEnhancedEncryptionPolicy](Get-TeamsEnhancedEncryptionPolicy.md) -Returns information about the teams enhanced encryption policies configured for use in your organization. - -### [Get-CsTeamsMediaLoggingPolicy](Get-CsTeamsMediaLoggingPolicy.md) -Returns information about the Teams Media Logging policy. - -### [Get-TeamsShiftsPolicy](Get-TeamsShiftsPolicy.md) -{{Manually Enter Get-TeamsShiftsPolicy Description Here}} - +### [Get-TeamsAppInstallation](Get-TeamsAppInstallation.md) ### [Get-TeamTargetingHierarchyStatus](Get-TeamTargetingHierarchyStatus.md) -{{Manually Enter Get-TeamTargetingHierarchyStatus Description Here}} - -### [Grant-TeamsEnhancedEncryptionPolicy](Grant-TeamsEnhancedEncryptionPolicy.md) -Cmdlet to assign a specific Teams enhanced encryption Policy to a user. - +### [Get-TeamUser](Get-TeamUser.md) +### [Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md) +### [Grant-CsCallingLineIdentity](Grant-CsCallingLineIdentity.md) +### [Grant-CsCloudMeetingPolicy](Grant-CsCloudMeetingPolicy.md) +### [Grant-CsDialoutPolicy](Grant-CsDialoutPolicy.md) +### [Grant-CsExternalAccessPolicy](Grant-CsExternalAccessPolicy.md) +### [Grant-CsExternalUserCommunicationPolicy](Grant-CsExternalUserCommunicationPolicy.md) +### [Grant-CsGroupPolicyPackageAssignment](Grant-CsGroupPolicyPackageAssignment.md) +### [Grant-CsOnlineVoicemailPolicy](Grant-CsOnlineVoicemailPolicy.md) +### [Grant-CsOnlineVoiceRoutingPolicy](Grant-CsOnlineVoiceRoutingPolicy.md) +### [Grant-CsTeamsAppPermissionPolicy](Grant-CsTeamsAppPermissionPolicy.md) +### [Grant-CsTeamsAppSetupPolicy](Grant-CsTeamsAppSetupPolicy.md) +### [Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +### [Grant-CsTeamsCallHoldPolicy](Grant-CsTeamsCallHoldPolicy.md) +### [Grant-CsTeamsCallingPolicy](Grant-CsTeamsCallingPolicy.md) +### [Grant-CsTeamsCallParkPolicy](Grant-CsTeamsCallParkPolicy.md) +### [Grant-CsTeamsChannelsPolicy](Grant-CsTeamsChannelsPolicy.md) +### [Grant-CsTeamsComplianceRecordingPolicy](Grant-CsTeamsComplianceRecordingPolicy.md) +### [Grant-CsTeamsCortanaPolicy](Grant-CsTeamsCortanaPolicy.md) +### [Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +### [Grant-CsTeamsEmergencyCallRoutingPolicy](Grant-CsTeamsEmergencyCallRoutingPolicy.md) +### [Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +### [Grant-CsTeamsEventsPolicy](Grant-CsTeamsEventsPolicy.md) +### [Grant-CsTeamsFeedbackPolicy](Grant-CsTeamsFeedbackPolicy.md) +### [Grant-CsTeamsFilesPolicy](Grant-CsTeamsFilesPolicy.md) +### [Grant-CsTeamsIPPhonePolicy](Grant-CsTeamsIPPhonePolicy.md) ### [Grant-CsTeamsMediaLoggingPolicy](Grant-CsTeamsMediaLoggingPolicy.md) -Assigns Teams Media Logging policy to a user, group of users or the entire tenant. - -### [Grant-TeamsShiftsPolicy](Grant-TeamsShiftsPolicy.md) -{{Manually Enter Grant-TeamsShiftsPolicy Description Here}} - +### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +### [Grant-CsTeamsMeetingBroadcastPolicy](Grant-CsTeamsMeetingBroadcastPolicy.md) +### [Grant-CsTeamsMeetingPolicy](Grant-CsTeamsMeetingPolicy.md) +### [Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.md) +### [Grant-CsTeamsMessagingPolicy](Grant-CsTeamsMessagingPolicy.md) +### [Grant-CsTeamsMobilityPolicy](Grant-CsTeamsMobilityPolicy.md) +### [Grant-CsTeamsRecordingRollOutPolicy](Grant-CsTeamsRecordingRollOutPolicy.md) +### [Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +### [Grant-CsTeamsShiftsPolicy](Grant-CsTeamsShiftsPolicy.md) +### [Grant-CsTeamsUpdateManagementPolicy](Grant-CsTeamsUpdateManagementPolicy.md) +### [Grant-CsTeamsUpgradePolicy](Grant-CsTeamsUpgradePolicy.md) +### [Grant-CsTeamsVdiPolicy](Grant-CsTeamsVdiPolicy.md) +### [Grant-CsTeamsVideoInteropServicePolicy](Grant-CsTeamsVideoInteropServicePolicy.md) +### [Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +### [Grant-CsTeamsVoiceApplicationsPolicy](Grant-CsTeamsVoiceApplicationsPolicy.md) +### [Grant-CsTeamsWorkLoadPolicy](Grant-CsTeamsWorkLoadPolicy.md) +### [Grant-CsTeamsWorkLocationDetectionPolicy](Grant-CsTeamsWorkLocationDetectionPolicy.md) +### [Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +### [Grant-CsUserPolicyPackage](Grant-CsUserPolicyPackage.md) +### [Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) +### [Import-CsOnlineAudioFile](Import-CsOnlineAudioFile.md) +### [New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md) +### [New-CsAutoAttendant](New-CsAutoAttendant.md) +### [New-CsAutoAttendantCallableEntity](New-CsAutoAttendantCallableEntity.md) +### [New-CsAutoAttendantCallFlow](New-CsAutoAttendantCallFlow.md) +### [New-CsAutoAttendantCallHandlingAssociation](New-CsAutoAttendantCallHandlingAssociation.md) +### [New-CsAutoAttendantDialScope](New-CsAutoAttendantDialScope.md) +### [New-CsAutoAttendantMenu](New-CsAutoAttendantMenu.md) +### [New-CsAutoAttendantMenuOption](New-CsAutoAttendantMenuOption.md) +### [New-CsAutoAttendantPrompt](New-CsAutoAttendantPrompt.md) +### [New-CsBatchPolicyAssignmentOperation](New-CsBatchPolicyAssignmentOperation.md) +### [New-CsBatchPolicyPackageAssignmentOperation](New-CsBatchPolicyPackageAssignmentOperation.md) +### [New-CsBatchTeamsDeployment](New-CsBatchTeamsDeployment.md) +### [New-CsCallingLineIdentity](New-CsCallingLineIdentity.md) +### [New-CsCallQueue](New-CsCallQueue.md) +### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) +### [New-CsCustomPolicyPackage](New-CsCustomPolicyPackage.md) +### [New-CsEdgeAllowAllKnownDomains](New-CsEdgeAllowAllKnownDomains.md) +### [New-CsEdgeAllowList](New-CsEdgeAllowList.md) +### [New-CsEdgeDomainPattern](New-CsEdgeDomainPattern.md) +### [New-CsExternalAccessPolicy](New-CsExternalAccessPolicy.md) +### [New-CsGroupPolicyAssignment](New-CsGroupPolicyAssignment.md) +### [New-CsHybridTelephoneNumber](New-CsHybridTelephoneNumber.md) +### [New-CsInboundBlockedNumberPattern](New-CsInboundBlockedNumberPattern.md) +### [New-CsInboundExemptNumberPattern](New-CsInboundExemptNumberPattern.md) +### [New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +### [New-CsOnlineApplicationInstanceAssociation](New-CsOnlineApplicationInstanceAssociation.md) +### [New-CsCsOnlineAudioConferencingRoutingPolicy][New-CsOnlineAudioConferencingRoutingPolicy.md] +### [New-CsOnlineDateTimeRange](New-CsOnlineDateTimeRange.md) +### [New-CsOnlineLisCivicAddress](New-CsOnlineLisCivicAddress.md) +### [New-CsOnlineLisLocation](New-CsOnlineLisLocation.md) +### [New-CsOnlinePSTNGateway](New-CsOnlinePSTNGateway.md) +### [New-CsOnlineSchedule](New-CsOnlineSchedule.md) +### [New-CsOnlineTelephoneNumberOrder](New-CsOnlineTelephoneNumberOrder.md) +### [New-CsOnlineTimeRange](New-CsOnlineTimeRange.md) +### [New-CsOnlineVoicemailPolicy](New-CsOnlineVoicemailPolicy.md) +### [New-CsOnlineVoiceRoute](New-CsOnlineVoiceRoute.md) +### [New-CsOnlineVoiceRoutingPolicy](New-CsOnlineVoiceRoutingPolicy.md) +### [New-CsTeamsAppPermissionPolicy](New-CsTeamsAppPermissionPolicy.md) +### [New-CsTeamsAppSetupPolicy](New-CsTeamsAppSetupPolicy.md) +### [New-CsTeamsAudioConferencingPolicy](New-CsTeamsAudioConferencingPolicy.md) +### [New-CsTeamsCallHoldPolicy](New-CsTeamsCallHoldPolicy.md) +### [New-CsTeamsCallingPolicy](New-CsTeamsCallingPolicy.md) +### [New-CsTeamsCallParkPolicy](New-CsTeamsCallParkPolicy.md) +### [New-CsTeamsChannelsPolicy](New-CsTeamsChannelsPolicy.md) +### [New-CsTeamsComplianceRecordingApplication](New-CsTeamsComplianceRecordingApplication.md) +### [New-CsTeamsComplianceRecordingPairedApplication](New-CsTeamsComplianceRecordingPairedApplication.md) +### [New-CsTeamsComplianceRecordingPolicy](New-CsTeamsComplianceRecordingPolicy.md) +### [New-CsTeamsCortanaPolicy](New-CsTeamsCortanaPolicy.md) +### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +### [New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +### [New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) +### [New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +### [New-CsTeamsEmergencyCallRoutingPolicy](New-CsTeamsEmergencyCallRoutingPolicy.md) +### [New-CsTeamsEmergencyNumber](New-CsTeamsEmergencyNumber.md) +### [New-CsTeamsEnhancedEncryptionPolicy](New-CsTeamsEnhancedEncryptionPolicy.md) +### [New-CsTeamsEventsPolicy](New-CsTeamsEventsPolicy.md) +### [New-CsTeamsFeedbackPolicy](New-CsTeamsFeedbackPolicy.md) +### [New-CsTeamsFilesPolicy](New-CsTeamsFilesPolicy.md) +### [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.md) +### [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md) +### [New-CsTeamsIPPhonePolicy](New-CsTeamsIPPhonePolicy.md) +### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +### [New-CsTeamsMeetingBroadcastPolicy](New-CsTeamsMeetingBroadcastPolicy.md) +### [New-CsTeamsMeetingPolicy](New-CsTeamsMeetingPolicy.md) +### [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.md) +### [New-CsTeamsMessagingPolicy](New-CsTeamsMessagingPolicy.md) +### [New-CsTeamsMobilityPolicy](New-CsTeamsMobilityPolicy.md) +### [New-CsTeamsNetworkRoamingPolicy](New-CsTeamsNetworkRoamingPolicy.md) +### [New-CsTeamsPinnedApp](New-CsTeamsPinnedApp.md) +### [New-CsTeamsRecordingRollOutPolicy](New-CsTeamsRecordingRollOutPolicy.md) +### [New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +### [New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +### [New-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.md) +### [New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +### [New-CsTeamsShiftsPolicy](New-CsTeamsShiftsPolicy.md) +### [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +### [New-CsTeamsTranslationRule](New-CsTeamsTranslationRule.md) +### [New-CsTeamsUnassignedNumberTreatment](New-CsTeamsUnassignedNumberTreatment.md) +### [New-CsTeamsUpdateManagementPolicy](New-CsTeamsUpdateManagementPolicy.md) +### [New-CsTeamsVdiPolicy](New-CsTeamsVdiPolicy.md) +### [New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +### [New-CsTeamsVoiceApplicationsPolicy](New-CsTeamsVoiceApplicationsPolicy.md) +### [New-CsTeamsWorkLoadPolicy](New-CsTeamsWorkLoadPolicy.md) +### [New-CsTeamsWorkLocationDetectionPolicy](New-CsTeamsWorkLocationDetectionPolicy.md) +### [New-CsTeamTemplate](New-CsTeamTemplate.md) +### [New-CsTenantDialPlan](New-CsTenantDialPlan.md) +### [New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +### [New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +### [New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +### [New-CsTenantTrustedIPAddress](New-CsTenantTrustedIPAddress.md) +### [New-CsUserCallingDelegate](New-CsUserCallingDelegate.md) +### [New-CsVideoInteropServiceProvider](New-CsVideoInteropServiceProvider.md) +### [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) ### [New-Team](New-Team.md) -{{Manually Enter New-Team Description Here}} - ### [New-TeamChannel](New-TeamChannel.md) -{{Manually Enter New-TeamChannel Description Here}} - ### [New-TeamsApp](New-TeamsApp.md) -{{Manually Enter New-TeamsApp Description Here}} - -### [New-TeamsEnhancedEncryptionPolicy](New-TeamsEnhancedEncryptionPolicy.md) -Use this cmdlet to create a new Teams enhanced encryption policy. - -### [New-TeamsShiftsPolicy](New-TeamsShiftsPolicy.md) -{{Manually Enter New-TeamsShiftsPolicy Description Here}} - +### [Register-CsOnlineDialInConferencingServiceNumber](Register-CsOnlineDialInConferencingServiceNumber.md) +### [Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md) +### [Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +### [Remove-CsCallingLineIdentity](Remove-CsCallingLineIdentity.md) +### [Remove-CsCallQueue](Remove-CsCallQueue.md) +### [Remove-CsCustomPolicyPackage](Remove-CsCustomPolicyPackage.md) +### [Remove-CsExternalAccessPolicy](Remove-CsExternalAccessPolicy.md) +### [Remove-CsGroupPolicyAssignment](Remove-CsGroupPolicyAssignment.md) +### [Remove-CsHybridTelephoneNumber](Remove-CsHybridTelephoneNumber.md) +### [Remove-CsInboundBlockedNumberPattern](Remove-CsInboundBlockedNumberPattern.md) +### [Remove-CsInboundExemptNumberPattern](Remove-CsInboundExemptNumberPattern.md) +### [Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +### [Remove-CsCsOnlineAudioConferencingRoutingPolicy][Remove-CsOnlineAudioConferencingRoutingPolicy.md] +### [Remove-CsOnlineAudioFile](Remove-CsOnlineAudioFile.md) +### [Remove-CsOnlineDialInConferencingTenantSettings](Remove-CsOnlineDialInConferencingTenantSettings.md) +### [Remove-CsOnlineLisCivicAddress](Remove-CsOnlineLisCivicAddress.md) +### [Remove-CsOnlineLisLocation](Remove-CsOnlineLisLocation.md) +### [Remove-CsOnlineLisPort](Remove-CsOnlineLisPort.md) +### [Remove-CsOnlineLisSubnet](Remove-CsOnlineLisSubnet.md) +### [Remove-CsOnlineLisSwitch](Remove-CsOnlineLisSwitch.md) +### [Remove-CsOnlineLisWirelessAccessPoint](Remove-CsOnlineLisWirelessAccessPoint.md) +### [Remove-CsOnlinePSTNGateway](Remove-CsOnlinePSTNGateway.md) +### [Remove-CsOnlineSchedule](Remove-CsOnlineSchedule.md) +### [Remove-CsOnlineTelephoneNumber](Remove-CsOnlineTelephoneNumber.md) +### [Remove-CsOnlineVoicemailPolicy](Remove-CsOnlineVoicemailPolicy.md) +### [Remove-CsOnlineVoiceRoute](Remove-CsOnlineVoiceRoute.md) +### [Remove-CsOnlineVoiceRoutingPolicy](Remove-CsOnlineVoiceRoutingPolicy.md) +### [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) +### [Remove-CsTeamsAppPermissionPolicy](Remove-CsTeamsAppPermissionPolicy.md) +### [Remove-CsTeamsAppSetupPolicy](Remove-CsTeamsAppSetupPolicy.md) +### [Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) +### [Remove-CsTeamsCallHoldPolicy](Remove-CsTeamsCallHoldPolicy.md) +### [Remove-CsTeamsCallingPolicy](Remove-CsTeamsCallingPolicy.md) +### [Remove-CsTeamsCallParkPolicy](Remove-CsTeamsCallParkPolicy.md) +### [Remove-CsTeamsChannelsPolicy](Remove-CsTeamsChannelsPolicy.md) +### [Remove-CsTeamsComplianceRecordingApplication](Remove-CsTeamsComplianceRecordingApplication.md) +### [Remove-CsTeamsComplianceRecordingPolicy](Remove-CsTeamsComplianceRecordingPolicy.md) +### [Remove-CsTeamsCortanaPolicy](Remove-CsTeamsCortanaPolicy.md) +### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +### [Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +### [Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) +### [Remove-CsTeamsEmergencyCallRoutingPolicy](Remove-CsTeamsEmergencyCallRoutingPolicy.md) +### [Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy.md) +### [Remove-CsTeamsFeedbackPolicy](Remove-CsTeamsFeedbackPolicy.md) +### [Remove-CsTeamsFilesPolicy](Remove-CsTeamsFilesPolicy.md) +### [Remove-CsTeamsIPPhonePolicy](Remove-CsTeamsIPPhonePolicy.md) +### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +### [Remove-CsTeamsMeetingBroadcastPolicy](Remove-CsTeamsMeetingBroadcastPolicy.md) +### [Remove-CsTeamsMeetingPolicy](Remove-CsTeamsMeetingPolicy.md) +### [Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.md) +### [Remove-CsTeamsMessagingPolicy](Remove-CsTeamsMessagingPolicy.md) +### [Remove-CsTeamsMobilityPolicy](Remove-CsTeamsMobilityPolicy.md) +### [Remove-CsTeamsNetworkRoamingPolicy](Remove-CsTeamsNetworkRoamingPolicy.md) +### [Remove-CsTeamsPinnedApp](Remove-CsTeamsPinnedApp.md) +### [Remove-CsTeamsRecordingRollOutPolicy](Remove-CsTeamsRecordingRollOutPolicy.md) +### [Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +### [Remove-CsTeamsShiftsConnection](Remove-CsTeamsShiftsConnection.md) +### [Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +### [Remove-CsTeamsShiftsConnectionTeamMap](Remove-CsTeamsShiftsConnectionTeamMap.md) +### [Remove-CsTeamsShiftsPolicy](Remove-CsTeamsShiftsPolicy.md) +### [Remove-CsTeamsShiftsScheduleRecord](Remove-CsTeamsShiftsScheduleRecord.md) +### [Remove-CsTeamsSurvivableBranchAppliance](Remove-CsTeamsSurvivableBranchAppliance.md) +### [Remove-CsTeamsSurvivableBranchAppliancePolicy](Remove-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Remove-CsTeamsTargetingPolicy](Remove-CsTeamsTargetingPolicy.md) +### [Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +### [Remove-CsTeamsTranslationRule](Remove-CsTeamsTranslationRule.md) +### [Remove-CsTeamsUnassignedNumberTreatment](Remove-CsTeamsUnassignedNumberTreatment.md) +### [Remove-CsTeamsUpdateManagementPolicy](Remove-CsTeamsUpdateManagementPolicy.md) +### [Remove-CsTeamsVdiPolicy](Remove-CsTeamsVdiPolicy.md) +### [Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +### [Remove-CsTeamsVoiceApplicationsPolicy](Remove-CsTeamsVoiceApplicationsPolicy.md) +### [Remove-CsTeamsWorkLoadPolicy](Remove-CsTeamsWorkLoadPolicy.md) +### [Remove-CsTeamsWorkLocationDetectionPolicy](Remove-CsTeamsWorkLocationDetectionPolicy.md) +### [Remove-CsTeamTemplate](Remove-CsTeamTemplate.md) +### [Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +### [Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +### [Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +### [Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +### [Remove-CsTenantTrustedIPAddress](Remove-CsTenantTrustedIPAddress.md) +### [Remove-CsUserCallingDelegate](Remove-CsUserCallingDelegate.md) +### [Remove-CsVideoInteropServiceProvider](Remove-CsVideoInteropServiceProvider.md) +### [Remove-SharedWithTeam](Remove-SharedWithTeam.md) ### [Remove-Team](Remove-Team.md) -{{Manually Enter Remove-Team Description Here}} - ### [Remove-TeamChannel](Remove-TeamChannel.md) -{{Manually Enter Remove-TeamChannel Description Here}} - ### [Remove-TeamChannelUser](Remove-TeamChannelUser.md) -{{Manually Enter Remove-TeamChannelUser Description Here}} - ### [Remove-TeamsApp](Remove-TeamsApp.md) -{{Manually Enter Remove-TeamsApp Description Here}} - -### [Remove-TeamUser](Remove-TeamUser.md) -{{Manually Enter Remove-TeamUser Description Here}} - -### [Remove-TeamsEnhancedEncryptionPolicy](Remove-TeamsEnhancedEncryptionPolicy.md) -Use this cmdlet to remove an existing Teams enhanced encryption policy. - -### [Remove-TeamsShiftsPolicy](Remove-TeamsShiftsPolicy.md) -{{Manually Enter Remove-TeamsShiftsPolicy Description Here}} - +### [Remove-TeamsAppInstallation](Remove-TeamsAppInstallation.md) ### [Remove-TeamTargetingHierarchy](Remove-TeamTargetingHierarchy.md) -{{Manually Enter Remove-TeamTargetingHierarchy Description Here}} - +### [Remove-TeamUser](Remove-TeamUser.md) +### [Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md) +### [Set-CsApplicationMeetingConfiguration](Set-CsApplicationMeetingConfiguration.md) +### [Set-CsAutoAttendant](Set-CsAutoAttendant.md) +### [Set-CsCallingLineIdentity](Set-CsCallingLineIdentity.md) +### [Set-CsCallQueue](Set-CsCallQueue.md) +### [Set-CsExternalAccessPolicy](Set-CsExternalAccessPolicy.md) +### [Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) +### [Set-CsInboundBlockedNumberPattern](Set-CsInboundBlockedNumberPattern.md) +### [Set-CsInboundExemptNumberPattern](Set-CsInboundExemptNumberPattern.md) +### [Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +### [Set-CsCsOnlineAudioConferencingRoutingPolicy][Set-CsOnlineAudioConferencingRoutingPolicy.md] +### [Set-CsOnlineDialInConferencingBridge](Set-CsOnlineDialInConferencingBridge.md) +### [Set-CsOnlineDialInConferencingServiceNumber](Set-CsOnlineDialInConferencingServiceNumber.md) +### [Set-CsOnlineDialInConferencingTenantSettings](Set-CsOnlineDialInConferencingTenantSettings.md) +### [Set-CsOnlineDialInConferencingUser](Set-CsOnlineDialInConferencingUser.md) +### [Set-CsOnlineEnhancedEmergencyServiceDisclaimer](Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md) +### [Set-CsOnlineLisCivicAddress](Set-CsOnlineLisCivicAddress.md) +### [Set-CsOnlineLisLocation](Set-CsOnlineLisLocation.md) +### [Set-CsOnlineLisPort](Set-CsOnlineLisPort.md) +### [Set-CsOnlineLisSubnet](Set-CsOnlineLisSubnet.md) +### [Set-CsOnlineLisSwitch](Set-CsOnlineLisSwitch.md) +### [Set-CsOnlineLisWirelessAccessPoint](Set-CsOnlineLisWirelessAccessPoint.md) +### [Set-CsOnlinePSTNGateway](Set-CsOnlinePSTNGateway.md) +### [Set-CsOnlinePstnUsage](Set-CsOnlinePstnUsage.md) +### [Set-CsOnlineSchedule](Set-CsOnlineSchedule.md) +### [Set-CsOnlineVoiceApplicationInstance](Set-CsOnlineVoiceApplicationInstance.md) +### [Set-CsOnlineVoicemailPolicy](Set-CsOnlineVoicemailPolicy.md) +### [Set-CsOnlineVoicemailUserSettings](Set-CsOnlineVoicemailUserSettings.md) +### [Set-CsOnlineVoiceRoute](Set-CsOnlineVoiceRoute.md) +### [Set-CsOnlineVoiceRoutingPolicy](Set-CsOnlineVoiceRoutingPolicy.md) +### [Set-CsOnlineVoiceUser](Set-CsOnlineVoiceUser.md) +### [Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +### [Set-CsTeamsAcsFederationConfiguration](Set-CsTeamsAcsFederationConfiguration.md) +### [Set-CsTeamsAppPermissionPolicy](Set-CsTeamsAppPermissionPolicy.md) +### [Set-CsTeamsAppSetupPolicy](Set-CsTeamsAppSetupPolicy.md) +### [Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +### [Set-CsTeamsCallHoldPolicy](Set-CsTeamsCallHoldPolicy.md) +### [Set-CsTeamsCallingPolicy](Set-CsTeamsCallingPolicy.md) +### [Set-CsTeamsCallParkPolicy](Set-CsTeamsCallParkPolicy.md) +### [Set-CsTeamsChannelsPolicy](Set-CsTeamsChannelsPolicy.md) +### [Set-CsTeamsClientConfiguration](Set-CsTeamsClientConfiguration.md) +### [Set-CsTeamsComplianceRecordingApplication](Set-CsTeamsComplianceRecordingApplication.md) +### [Set-CsTeamsComplianceRecordingPolicy](Set-CsTeamsComplianceRecordingPolicy.md) +### [Set-CsTeamsCortanaPolicy](Set-CsTeamsCortanaPolicy.md) +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +### [Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +### [Set-CsTeamsEducationAssignmentsAppPolicy](Set-CsTeamsEducationAssignmentsAppPolicy.md) +### [Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) +### [Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) +### [Set-CsTeamsEmergencyCallRoutingPolicy](Set-CsTeamsEmergencyCallRoutingPolicy.md) +### [Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +### [Set-CsTeamsEventsPolicy](Set-CsTeamsEventsPolicy.md) +### [Set-CsTeamsFeedbackPolicy](Set-CsTeamsFeedbackPolicy.md) +### [Set-CsTeamsFilesPolicy](Set-CsTeamsFilesPolicy.md) +### [Set-CsTeamsGuestCallingConfiguration](Set-CsTeamsGuestCallingConfiguration.md) +### [Set-CsTeamsGuestMeetingConfiguration](Set-CsTeamsGuestMeetingConfiguration.md) +### [Set-CsTeamsGuestMessagingConfiguration](Set-CsTeamsGuestMessagingConfiguration.md) +### [Set-CsTeamsIPPhonePolicy](Set-CsTeamsIPPhonePolicy.md) +### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) +### [Set-CsTeamsMeetingBroadcastConfiguration](Set-CsTeamsMeetingBroadcastConfiguration.md) +### [Set-CsTeamsMeetingBroadcastPolicy](Set-CsTeamsMeetingBroadcastPolicy.md) +### [Set-CsTeamsMeetingConfiguration](Set-CsTeamsMeetingConfiguration.md) +### [Set-CsTeamsMeetingPolicy](Set-CsTeamsMeetingPolicy.md) +### [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.md) +### [Set-CsTeamsMessagingConfiguration](Set-CsTeamsMessagingConfiguration.md) +### [Set-CsTeamsMessagingPolicy](Set-CsTeamsMessagingPolicy.md) +### [Set-CsTeamsMobilityPolicy](Set-CsTeamsMobilityPolicy.md) +### [Set-CsTeamsNetworkRoamingPolicy](Set-CsTeamsNetworkRoamingPolicy.md) +### [Set-CsTeamsPinnedApp](Set-CsTeamsPinnedApp.md) +### [Set-CsTeamsRecordingRollOutPolicy](Set-CsTeamsRecordingRollOutPolicy.md) +### [Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +### [Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +### [Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +### [Set-CsTeamsShiftsPolicy](Set-CsTeamsShiftsPolicy.md) +### [Set-CsTeamsSipDevicesConfiguration](Set-CsTeamsSipDevicesConfiguration.md) +### [Set-CsTeamsSurvivableBranchAppliance](Set-CsTeamsSurvivableBranchAppliance.md) +### [Set-CsTeamsSurvivableBranchAppliancePolicy](Set-CsTeamsSurvivableBranchAppliancePolicy.md) +### [Set-CsTeamsTargetingPolicy](Set-CsTeamsTargetingPolicy.md) +### [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +### [Set-CsTeamsTranslationRule](Set-CsTeamsTranslationRule.md) +### [Set-CsTeamsUnassignedNumberTreatment](Set-CsTeamsUnassignedNumberTreatment.md) +### [Set-CsTeamsUpdateManagementPolicy](Set-CsTeamsUpdateManagementPolicy.md) +### [Set-CsTeamsUpgradeConfiguration](Set-CsTeamsUpgradeConfiguration.md) +### [Set-CsTeamsVdiPolicy](Set-CsTeamsVdiPolicy.md) +### [Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +### [Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +### [Set-CsTeamsWorkLoadPolicy](Set-CsTeamsWorkLoadPolicy.md) +### [Set-CsTeamsWorkLocationDetectionPolicy](Set-CsTeamsWorkLocationDetectionPolicy.md) +### [Set-CsTenantBlockedCallingNumbers](Set-CsTenantBlockedCallingNumbers.md) +### [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +### [Set-CsTenantFederationConfiguration](Set-CsTenantFederationConfiguration.md) +### [Set-CsTenantMigrationConfiguration](Set-CsTenantMigrationConfiguration.md) +### [Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +### [Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +### [Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +### [Set-CsTenantTrustedIPAddress](Set-CsTenantTrustedIPAddress.md) +### [Set-CsUser](Set-CsUser.md) +### [Set-CsUserCallingDelegate](Set-CsUserCallingDelegate.md) +### [Set-CsUserCallingSettings](Set-CsUserCallingSettings.md) +### [Set-CsVideoInteropServiceProvider](Set-CsVideoInteropServiceProvider.md) ### [Set-Team](Set-Team.md) -{{Manually Enter Set-Team Description Here}} - ### [Set-TeamArchivedState](Set-TeamArchivedState.md) -{{Manually Enter Set-TeamArchivedState Description Here}} - ### [Set-TeamChannel](Set-TeamChannel.md) -{{Manually Enter Set-TeamChannel Description Here}} - ### [Set-TeamFunSettings](Set-TeamFunSettings.md) -{{Manually Enter Set-TeamFunSettings Description Here}} - ### [Set-TeamGuestSettings](Set-TeamGuestSettings.md) -{{Manually Enter Set-TeamGuestSettings Description Here}} - ### [Set-TeamMemberSettings](Set-TeamMemberSettings.md) -{{Manually Enter Set-TeamMemberSettings Description Here}} - ### [Set-TeamMessagingSettings](Set-TeamMessagingSettings.md) -{{Manually Enter Set-TeamMessagingSettings Description Here}} - ### [Set-TeamPicture](Set-TeamPicture.md) -{{Manually Enter Set-TeamPicture Description Here}} - -### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) -{{Manually Enter Set-TeamTargetingHierarchy Description Here}} - ### [Set-TeamsApp](Set-TeamsApp.md) -{{Manually Enter Set-TeamsApp Description Here}} - -### [Set-TeamsEnhancedEncryptionPolicy](Set-TeamsEnhancedEncryptionPolicy.md) -Use this cmdlet to update values in existing Teams enhanced encryption policy. - -### [Set-TeamsShiftsPolicy](Set-TeamsShiftsPolicy.md) -{{Manually Enter Set-TeamsShiftsPolicy Description Here}} +### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) +### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) +### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) +### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) +### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) +### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) +### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) +### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) +### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) +### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) +### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) +### [Update-TeamsAppInstallation](Update-TeamsAppInstallation.md) diff --git a/tools/office-cmdlet-updater/README.md b/tools/office-cmdlet-updater/README.md index f8d0061dd6..d4400fe9f0 100644 --- a/tools/office-cmdlet-updater/README.md +++ b/tools/office-cmdlet-updater/README.md @@ -18,7 +18,7 @@ - SharePoint Online: - https://www.microsoft.com/en-us/download/details.aspx?id=35588 - Exchange Online: - - cmdlets could be imported using [this guide](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) + - cmdlets could be imported using [this guide](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) 7. Run the app, type `node index` and press Enter in order to get info for all modules 8. Run the app for a certain module, type `node index -m `, with one of the following options - teams, skype, sharepoint, whiteboard, exchange, staffhub. For example, you should run `node index -m teams` to run the tool for Microsoft Teams 9. Run `node index -help` to get help information for all available commands diff --git a/whiteboard/docfx.json b/whiteboard/docfx.json index 57e35f76fd..b5ec7d6eab 100644 --- a/whiteboard/docfx.json +++ b/whiteboard/docfx.json @@ -54,6 +54,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author" : "tbrosman", "ms.author" : "tbrosman", "manager" : "shanejc", @@ -61,9 +62,8 @@ "ms.topic" : "reference", "ms.service" : "whiteboard-powershell", "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/whiteboard/docs-conceptual/overview.md b/whiteboard/docs-conceptual/overview.md index ab181bbc8a..38782d52de 100644 --- a/whiteboard/docs-conceptual/overview.md +++ b/whiteboard/docs-conceptual/overview.md @@ -41,7 +41,7 @@ Note: For more information on Execution_Policies, go to . +Cmdlets taking user IDs use the ID from Microsoft Entra ID. To get a user ID, you can use the Microsoft Graph Explorer. For more information, go to . ## Exporting Whiteboard Content diff --git a/whiteboard/mapping/monikerMapping.json b/whiteboard/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from whiteboard/mapping/monikerMapping.json rename to whiteboard/mapping/MAML2Yaml/monikerMapping.json diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md new file mode 100644 index 0000000000..1b2ef53c77 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md @@ -0,0 +1,111 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboards +applicable: Microsoft Whiteboard +title: Get-OriginalFluidWhiteboards +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-OriginalFluidWhiteboards + +## SYNOPSIS + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive and return them as objects. + +## SYNTAX + +```powershell +Get-OriginalFluidWhiteboards [-UserId] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001 +``` + +Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive. + +### Output + +```yaml +Drive Items found for User 00000000-0000-0000-0000-000000000001 --------------------------------------------------- +Name: TradeTestwhiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: 00000000-0000-0000-0000-000000000001 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: 00000000-0000-0000-0000-000000000001 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +``` + +## PARAMETERS + +### -UserId + +The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that user whiteboards. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md new file mode 100644 index 0000000000..e6779e12ce --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md @@ -0,0 +1,178 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboardsfortenant +applicable: Microsoft Whiteboard +title: Get-OriginalFluidWhiteboardsForTenant +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-OriginalFluidWhiteboardsForTenant + +## SYNOPSIS + +Gets one or more whiteboards that are originally created as fluid directly into OneDrive for all users under that admin and returns them as objects. + +## SYNTAX + +```powershell +Get-OriginalFluidWhiteboardsForTenant [-IncrementalRunName ] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are originally created as fluid directly into OneDrive and returns them as objects. It output all boards created directly into OneDrive in all user accounts under that Tenant + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant +``` + +Get all user's originally created fluid whiteboards in that tenant and outputs in cmd with all users whiteboards provided admin has access to all those users oneDrive for which it is intended to get whiteboards. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd --------------------------------------------------- +Name: Azure111 whiteboard 1.whiteboard +ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ +Last Modified: 02/13/2025 16:45:58 +Size: 23110 bytes +Migration Date: 02/13/2025 16:45:37 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +Name: Azure111 whiteboard.whiteboard +ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL +Last Modified: 02/19/2025 07:35:25 +Size: 12007 bytes +Migration Date: 02/19/2025 07:35:24 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS +Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive. +``` + +### EXAMPLE 2 + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant -IncrementalRunName 1 +``` + +Get all user's originally created fluid whiteboards in that tenant and incrementally creates file "WhiteboardsOriginalFluid-$IncrementalRunName.txt" with all users whiteboards provided admin has access to all those users oneDrive for which it is intended to get whiteboards. + +### Output + +```yaml +[ + "Name: Test11whiteboard.whiteboard", + "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", + "Last Modified: 03/06/2025 09:59:32", + "Size: 15222 bytes", + "Migration Date: 03/06/2025 09:58:57", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------", + "Name: Untitled.whiteboard", + "ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M", + "Last Modified: 02/19/2025 05:19:04", + "Size: 15307 bytes", + "Migration Date: 02/19/2025 05:19:04", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------" +] +[ + "Name: Azure111 whiteboard.whiteboard", + "ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL", + "Last Modified: 02/19/2025 07:35:25", + "Size: 12007 bytes", + "Migration Date: 02/19/2025 07:35:24", + "User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd", + "User Email: admin@M365x86764163.onmicrosoft.com", + "User Name: MOD Administrator", + "-----------------------------------------------" +] +``` + +## PARAMETERS + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: + +- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md index b3ae953859..a533b03ca5 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md @@ -1,7 +1,7 @@ --- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin -online version: https://docs.microsoft.com/powershell/module/whiteboard/get-whiteboard +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboard applicable: Microsoft Whiteboard title: Get-Whiteboard schema: 2.0.0 @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS -Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects. +Gets one or more whiteboards in Azure from the Microsoft Whiteboard service and returns them as objects. ## SYNTAX @@ -24,7 +24,7 @@ Get-Whiteboard [-UserId] [[-WhiteboardId] ] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +## EXAMPLES + +### EXAMPLE 1 + +This command gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +```powershell +PS C:\> Get-WhiteboardSettings +``` + +```Output +isClaimEnabled : True +privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} +tenantMetadata : @{isGovUser=False; isEduUser=False} +isSharePointDefault : False +isSharePointDefaultGa : True +isSharePointDefaultRolledOut : True +isAzureBlocked : False +licenseCheckInformation : Success +isFluidMigrationEnabled : False +isTenantAdminMigrationEnabled : True +isEnabled : True +isEnabledGa : True +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md new file mode 100644 index 0000000000..531dc66db0 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md @@ -0,0 +1,148 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenant +applicable: Microsoft Whiteboard +title: Get-WhiteboardsForTenant +schema: 2.0.0 +author: samanehrajabi +ms.author: srajabi +ms.reviewer: +--- + +# Get-WhiteboardsForTenant + +## SYNOPSIS + +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +## SYNTAX + +```powershell +Get-WhiteboardsForTenant [-Geography ] + [-IncrementalRunName ] + [-ForceAuthPrompt] + [] +``` + +## DESCRIPTION + +Gets all the whiteboards in Azure in a tenant in a specified geography. Returns a list of whiteboard objects. The data is pre-calculated approximately every two weeks and is not realtime. + +## EXAMPLES + +### EXAMPLE 1 + +This command gets all the whiteboards in Azure associated with the caller's tenant in Europe as a list of whiteboard metadata objects. + +```powershell +PS C:\> Get-WhiteboardsForTenant -Geography Europe +``` + +```Output +baseApi : eu.whiteboard.microsoft.com +id : 00000000-0000-0000-0000-000000000001 +userId : 00000000-0000-0000-0000-000000000000 +folioId : 00000000-0000-0000-0000-000000000000 +title : title1 +createdBy : 00000000-0000-0000-0000-000000000000 +ownerId : 00000000-0000-0000-0000-000000000000 +ownerTenantId : 00000000-0000-0000-0000-000000000000 +isShared : False +createdTime : 2022-09-10T19:59:03.3407011Z +invitedTime : +personalLastModifiedTime : 2022-09-11T15:53:32.4494737Z +lastModifiedTime : 2022-09-11T15:53:32.4494737Z +globalLastViewedTime : 2022-09-11T15:55:28.7242817Z +lastViewedTime : 2022-09-11T15:55:28.7242817Z +meetingId : +eTag : W/"datetime'2022-09-11T19%3A23%3A56.2845616Z'" + +baseApi : eu.whiteboard.microsoft.com +id : 00000000-0000-0000-0000-000000000002 +userId : 00000000-0000-0000-0000-000000000000 +folioId : 00000000-0000-0000-0000-000000000000 +title : title2 +createdBy : 00000000-0000-0000-0000-000000000000 +ownerId : 00000000-0000-0000-0000-000000000000 +ownerTenantId : 00000000-0000-0000-0000-000000000000 +isShared : False +createdTime : 2023-01-06T19:23:04.8807147Z +invitedTime : +personalLastModifiedTime : 2023-01-06T19:23:13.6235107Z +lastModifiedTime : 2023-01-06T19:23:13.6235107Z +globalLastViewedTime : 2023-01-06T19:23:56.0264268Z +lastViewedTime : 2023-01-06T19:23:56.0264268Z +meetingId : +eTag : W/"datetime'2023-01-06T19%3A22%3A42.6717851Z'" +``` + +## PARAMETERS + +### -Geography + +The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` (all boards not in Australia or Europe). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Use to resume a partially completed run. Use the same **IncrementalRunName** value on later calls to continue a previously canceled or failed run. Writes progress and results to `.txt` files in the current directory: + +- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. +- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided **IncrementalRunName**. This file should not be modified manually. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md new file mode 100644 index 0000000000..c29105b13b --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md @@ -0,0 +1,178 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenantmigrated +applicable: Microsoft Whiteboard +title: Get-WhiteboardsForTenantMigrated +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardsForTenantMigrated + +## SYNOPSIS + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +## SYNTAX + +```powershell +Get-WhiteboardsForTenantMigrated [-IncrementalRunName ] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. It output all boards migrated to OneDrive in all user accounts under that Tenant provided Admin have access to all those users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardsForTenantMigrated +``` + +Get all user's migrated whiteboards in that tenant and outputs in cmd with all users whiteboards provided admin has access to all those users oneDrive. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd --------------------------------------------------- +Name: Azure111 whiteboard 1.whiteboard +ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ +Last Modified: 02/13/2025 16:45:58 +Size: 23110 bytes +Migration Date: 02/13/2025 16:45:37 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +Name: Azure111 whiteboard.whiteboard +ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL +Last Modified: 02/19/2025 07:35:25 +Size: 12007 bytes +Migration Date: 02/19/2025 07:35:24 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS +Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive. +``` + +### EXAMPLE 2 + +```powershell +PS C:\>Get-WhiteboardsForTenantMigrated -IncrementalRunName 1 +``` + +Get all user's migrated whiteboards in that tenant and incrementally creates file "WhiteboardsMigrated-$IncrementalRunName.txt" with all users whiteboards provided admin has access to all those users oneDrive. + +### Output + +```yaml +[ + "Name: Test11whiteboard.whiteboard", + "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", + "Last Modified: 03/06/2025 09:59:32", + "Size: 15222 bytes", + "Migration Date: 03/06/2025 09:58:57", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------", + "Name: Untitled.whiteboard", + "ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M", + "Last Modified: 02/19/2025 05:19:04", + "Size: 15307 bytes", + "Migration Date: 02/19/2025 05:19:04", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------" +] +[ + "Name: Azure111 whiteboard.whiteboard", + "ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL", + "Last Modified: 02/19/2025 07:35:25", + "Size: 12007 bytes", + "Migration Date: 02/19/2025 07:35:24", + "User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd", + "User Email: admin@M365x86764163.onmicrosoft.com", + "User Name: MOD Administrator", + "-----------------------------------------------" +] +``` + +## PARAMETERS + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: + +- `WhiteboardsMigrated-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md new file mode 100644 index 0000000000..6bff3167e4 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md @@ -0,0 +1,111 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsmigrated +applicable: Microsoft Whiteboard +title: Get-WhiteboardsMigrated +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardsMigrated + +## SYNOPSIS + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +## SYNTAX + +```powershell +Get-WhiteboardsMigrated [-UserId] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are migrated to OneDrive for particular user and returns them as objects provided Admin have access to that user OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardsMigrated -UserId e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +``` + +Get all user's migrated whiteboards. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +``` + +## PARAMETERS + +### -UserId + +The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that users whiteboards. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md b/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md index b71778528d..a770d4b062 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md +++ b/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md @@ -1,7 +1,7 @@ --- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin -online version: https://docs.microsoft.com/powershell/module/whiteboard/invoke-transferallwhiteboards +online version: https://learn.microsoft.com/powershell/module/whiteboard/invoke-transferallwhiteboards applicable: Microsoft Whiteboard title: Invoke-TransferAllWhiteboards schema: 2.0.0 diff --git a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md index 13de991247..69a0893606 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md @@ -1,7 +1,7 @@ --- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin -online version: https://docs.microsoft.com/powershell/module/whiteboard/remove-whiteboard +online version: https://learn.microsoft.com/powershell/module/whiteboard/remove-whiteboard applicable: Microsoft Whiteboard title: Remove-Whiteboard schema: 2.0.0 diff --git a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md new file mode 100644 index 0000000000..5ceb33569e --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md @@ -0,0 +1,86 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/restore-whiteboard +applicable: Microsoft Whiteboard +title: Restore-Whiteboard +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Restore-Whiteboard + +## SYNOPSIS + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. + +## SYNTAX + +```powershell +Restore-Whiteboard [-WhiteboardId] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Restores the azure board. The migrated onedrive board will be retained to not lose any updates done to Azure board. +Restoration is only possible for approximately 90 days after migration, when the original board is still available. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Restore-Whiteboard -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` + +Restore the whiteboard. + +## PARAMETERS + +### -WhiteboardId + +The ID of a specific whiteboard to restore. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +(Optional) Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md index 70a1ab9a88..3b05afdd46 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md @@ -1,7 +1,7 @@ --- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin -online version: https://docs.microsoft.com/powershell/module/whiteboard/set-whiteboardowner +online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardowner applicable: Microsoft Whiteboard title: Set-WhiteboardOwner schema: 2.0.0 diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md new file mode 100644 index 0000000000..f7c57fa1bf --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -0,0 +1,92 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardsettings +applicable: Microsoft Whiteboard +title: Set-WhiteboardSettings +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Set-WhiteboardSettings + +## SYNOPSIS + +Get the users Whiteboard settings. + +## SYNTAX + +```powershell +Set-WhiteboardSettings + [-ForceAuthPrompt][-Settings] + [] +``` + +## DESCRIPTION + +Sets the tenant settings for the Microsoft Whiteboard services. + +## EXAMPLES + +### EXAMPLE 1 + +This command sets the tenant settings for the Microsoft Whiteboard services. + +```powershell +PS C:\> $settings = Get-WhiteboardSettings +$settings.isEnabledGa = $true +Set-WhiteboardSettings -Settings $settings +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -Settings + +The object to use as Whiteboard Settings. Should be retrieved via [Get-WhiteboardSettings](Get-WhiteboardSettings.md). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -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 + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md index c611290771..ba9d6b6572 100644 --- a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md @@ -8,18 +8,48 @@ title: Microsoft Whiteboard ## Description -The following cmdlet references are for Microsoft Whiteboard. See [Overview](https://docs.microsoft.com/powershell/whiteboard/overview) for details on installing the module. The module can only be run by users with Global Administrator or SharePoint Administrator roles. +The following cmdlet references are for Microsoft Whiteboard. See [Overview](https://learn.microsoft.com/powershell/whiteboard/overview) for details on installing the module. The module can only be run by users with Global Administrator or SharePoint Administrator roles. The module described here is for Whiteboard content stored in Azure. + +> [!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. To learn more, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles). + +## Prerequisite for commands Get-OriginalFluidWhiteboards, Get-OriginalFluidWhiteboardsForTenant, Get-WhiteboardsMigrated, Get-WhiteboardsForTenantMigrated to get whiteboards from users OneDrive + +Inorder to get whiteboards which is in OneDrive for any users, Admin should have access to all those users OneDrive. +Admin can use Admin portal to give "Site-CollectionAdmin" role to users account for which they want to get all whiteboards in OneDrive. +Go to sharepoint Admin center > On left hand side, click "More features" > In User profiles, click "Open". +Manage User profiles > Search user > Manage site collection owners > Add Admin as Site Collection Administrator. ## Microsoft Whiteboard Admin cmdlets ### [Get-Whiteboard](Get-Whiteboard.md) -Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects. +Gets one or more whiteboards in Azure from the Microsoft Whiteboard service and returns them as objects. ### [Get-WhiteboardOwners](Get-WhiteboardOwners.md) Gets all the users in a tenant who own whiteboards in a specified geography. +### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) + +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +### [Get-OriginalFluidWhiteboards](Get-OriginalFluidWhiteboards.md) + +Gets one or more whiteboards that are originally created as Fluid whiteboards directly into users OneDrive and return them as objects. + +### [Get-OriginalFluidWhiteboardsForTenant](Get-OriginalFluidWhiteboardsForTenant.md) + +Gets one or more whiteboards that are originally created as fluid whiteboards directly into OneDrive for all users under that admin and returns them as objects. + +### [Get-WhiteboardsMigrated](Get-WhiteboardsMigrated.md) + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +### [Get-WhiteboardsForTenantMigrated](Get-WhiteboardsForTenantMigrated.md) + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + ### [Invoke-TransferAllWhiteboard](Invoke-TransferAllWhiteboards.md) Transfer ownership of all whiteboards owned by a user to another user. @@ -31,3 +61,15 @@ Deletes the specified whiteboard for the given user from the Microsoft Whiteboar ### [Set-WhiteboardOwner](Set-WhiteboardOwner.md) Sets the owner for a whiteboard. + +### [Restore-Whiteboard](Restore-Whiteboard.md) + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. + +### [Get-WhiteboardSettings](Get-WhiteboardSettings.md) + +Gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +### [Set-WhiteboardSettings](Set-WhiteboardSettings.md) + +Sets the tenant settings for the Microsoft Whiteboard services.